20250807

help/class_desc/attributes/NotNull.md

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