20250805-1

help/class_desc/enums/DBOperation.md

@@ -0,0 +1,82 @@
+# Перечисление `DBOperation`
+
+Перечисление `DBOperation` представляет собой перечень возможных операций, выполняемых над базой данных. Эти операции
+используются для обозначения действий, связанных с управлением данными и таблицами, такими как вставка, получение,
+обновление, удаление и подсчет элементов, а также создание и удаление таблиц.
+
+## Основная информация
+
+- **Автор**: Александр Бабаев
+- **Версия**: 1.0
+- **Дата начала поддержки**: с версии 1.0
+
+## Пространство имен и зависимости
+
+```php
+namespace goodboyalex\php_db_components_pack\enums;
+
+use goodboyalex\php_components_pack\traits\EnumExtensionsTrait;
+```
+
+## Возможные значения перечисления
+
+1. **Insert** (`case Insert = 0`)  
+   Операция вставки данных в базу данных.
+
+2. **Get** (`case Get = 1`)  
+   Операция получения данных из базы данных.
+
+3. **Update** (`case Update = 2`)  
+   Операция обновления существующего элемента в базе данных.
+
+4. **Delete** (`case Delete = 3`)  
+   Операция удаления элемента из базы данных.
+
+5. **Count** (`case Count = 4`)  
+   Операция подсчёта количества элементов в базе данных.
+
+6. **CreateTable** (`case CreateTable = 5`)  
+   Операция создания новой таблицы в базе данных.
+
+7. **DropTable** (`case DropTable = 6`)  
+   Операция удаления существующей таблицы из базы данных.
+
+## Особенности
+
+- **Наследует трейт `EnumExtensionsTrait`**: Предоставляет дополнительный функционал для расширения возможностей работы
+  с перечислениями, включая вспомогательные методы для удобного обращения к элементам перечисления.
+
+## Использование перечисления
+
+Пример использования перечисления в вашем приложении:
+
+```php
+use goodboyalex\php_db_components_pack\enums\DBOperation;
+
+// Определили операцию вставки
+$operation = DBOperation::Insert;
+
+switch ($operation) {
+    case DBOperation::Insert:
+        echo "Операция вставки данных.";
+        break;
+    case DBOperation::Get:
+        echo "Операция получения данных.";
+        break;
+    default:
+        echo "Другая операция.";
+}
+```
+
+## Совместимость
+
+Перечисление совместимо с современными версиями PHP, начиная с версии 8.1, поддерживающей нативные перечисления (
+`enum`). Если используется более ранняя версия PHP, возможно потребуется альтернативная реализация на основе классов или
+сторонних пакетов.
+
+## Вывод
+
+Этот класс является частью библиотеки `goodboyalex/php_db_components_pack` и предназначен для унификации работы с
+различными системами управления базами данных посредством стандартного интерфейса PDO.
+
+[На гравную](../../index.md)