20250807

help/class_desc/attributes/Unique.md

@@ -0,0 +1,57 @@
+# Атрибут `Unique`
+
+Атрибут `Unique` предназначен для указания, что определенное поле в модели данных должно содержать уникальные значения.
+Это значит, что ни одно значение в данном поле не может повторяться среди других записей.
+
+## Основное назначение
+
+Атрибут используется для явного указания того, что поле должно содержать уникальные значения. Такие поля часто
+применяются для хранения идентификаторов, электронных почтовых адресов, телефонных номеров и других данных, которые
+обязаны быть уникальными.
+
+## Пример использования атрибута
+
+Допустим, у вас есть модель данных, описывающая пользователя, и вы хотите явно указать, что электронный адрес должен
+быть уникальным:
+
+```php
+use goodboyalex\php_db_components_pack\attributes\Unique;
+
+final class User
+{
+    #[Unique]
+    private string $Email;
+
+    // Остальные поля и геттеры/сеттеры...
+}
+```
+
+В данном примере атрибут `#[Unique]` применяется к полю `$Email`, явно указывая, что электронная почта должна быть
+уникальной.
+
+## Пространство имён
+
+Атрибут объявлен в пространстве имён:
+
+```php
+namespace goodboyalex\php_db_components_pack\attributes;
+```
+
+## Версии и автор
+
+- **Автор**: Александр Бабаев
+- **Версия**: 1.0
+- **Дата выпуска**: с версии 1.0
+
+## Особенности
+
+- **Применяется только к полям (properties).** Атрибут используется исключительно для аннотирования полей классов,
+  которые соответствуют столбцам базы данных.
+
+## Когда использовать атрибут?
+
+Атрибут `Unique` идеально подходит для ситуации, когда требуется строго соблюдать уникальность значений в поле. Это
+распространённая практика для реквизитов вроде электронных писем, логинов, номеров телефонов и других важных
+идентификаторов.
+
+[На главную](../../index.md)