DevCraft Документации
УстаревшееMH Admin (Legacy)Back-EndClasses

Класс: MhDB

Документация по плагину класс: mhdb для DLE.

Краткое содержание:

Класс для работы с базой данных

Свойства

Методы

Подробности

  • Путь: engine/inc/maharder/_includes/database/MhDB.php

Свойства

private $em : ?\Cycle\ORM\EntityManager

Краткое содержание

Менеджер сущностей ORM, обеспечивающий операции CRUD и управление состоянием сущностей.

Описание

Инициализируется в методе setManager.

**Тип: ** EntityManager

private $orm : ?\Cycle\ORM\ORM

Краткое содержание

ORM-класс для управления объектами и предоставления операций высокого уровня.

Описание

Используется для создания экземпляра ORM, управления сущностями, получением менеджера базы данных и выполнения запросов.

**Тип: ** ORM

private $orm_config : ?\Cycle\Database\Config\DatabaseConfig

Краткое содержание

Конфигурация базы данных для настройки параметров подключения, драйвера и других настроек.

Описание

Генерируется с помощью метода generateOrmConfig.

**Тип: ** DatabaseConfig

private $orm_manager : ?\Cycle\Database\DatabaseManager

Краткое содержание

Менеджер базы данных, предоставляющий функционал работы с подключениями и конфигурациями БД.

Описание

Генерируется с помощью метода generateManager.

**Тип: ** DatabaseManager

Подробности:

private $user_db : bool

Краткое содержание

Флаг, определяющий подключение к базе данных пользователя (true) или основной базы данных (false).

Описание

Используется при создании конфигурации базы данных.

Тип: Логические значения

Методы

__construct

public __construct(bool  user_db = false) : mixed
Краткое содержание

Конструктор класса MhDB.

Описание

Настраивает базу данных, инициализирует ORM, а также управляет объектом EntityManager.

Свойства:
НазваниеТипПо умолчанию
$user_dbboolfalse
Ошибки:
ТипОписание
\Cycle\ORM\Exception\SchemaExceptionЕсли при генерации ORM произошла ошибка в схеме базы данных.
\Cycle\Migrations\Exception\MigrationExceptionЕсли миграции не могут быть выполнены.
\RuntimeExceptionЕсли не удается нормально настроить конфигурацию подключения к базе данных.
Возвращает:
mixed

count

public count(object|string  entity) : int
Краткое содержание

Подсчитывает количество записей для указанной сущности.

Описание

Эта функция использует репозиторий, связанный с сущностью, для выполнения запроса на подсчет количества записей.

Свойства:
НазваниеТипПо умолчанию
$entityobject|string
Возвращает:
int

Количество записей в репозитории, связанных с данной сущностью.

create

public create(object  entity) : \ORM\Transaction\StateInterface
Краткое содержание

Обновляет предоставленную сущность в базе данных.

Описание

Эта функция выполняет процесс обновления сущности посредством вызова метода run, который предполагает выполнение различных ORM-операций, таких как persist.

Свойства:
НазваниеТипПо умолчанию
$entityobject
Ошибки:
ТипОписание
\ORM\Exception\EntityNotManagedExceptionЕсли сущность не управляется текущим менеджером сущностей.
\ORM\Exception\TransactionException|\ThrowableЕсли транзакция не может быть завершена.
Возвращает:
\ORM\Transaction\StateInterface

Возвращает состояние ORM-транзакции после обновления сущности.

delete

public delete(object|string  entity, int  pk) : \ORM\Transaction\StateInterface
Краткое содержание

Удаляет сущность на основе переданного объекта и первичного ключа.

Описание

Эта функция выполняет следующие шаги:

  1. Извлекает объект сущности из базы данных с помощью метода get.
  2. Передает этот объект менеджеру сущностей для удаления.
  3. Выполняет транзакцию удаления.
Свойства:
НазваниеТипПо умолчанию
$entityobject|string
$pkint
Ошибки:
ТипОписание
\ThrowableПри любой ошибке в ORM (например, сбой во время удаления).
Возвращает:
\ORM\Transaction\StateInterface

Возвращает состояние завершенной транзакции удаления.

get

public get(object|string  entity, int  pk) : object|null
Краткое содержание

Получает сущность из хранилища данных по её первичному ключу.

Свойства:
НазваниеТипПо умолчанию
$entityobject|string
$pkint
Возвращает:
object|null

Возвращает найденный объект сущности или null, если объект с заданным первичным ключом отсутствует.

getAll

public getAll(object|string  entity) : array
Краткое содержание

Получает все записи для указанной сущности из хранилища.

Описание

Этот метод использует репозиторий, ассоциированный с указанной сущностью, для получения всех записей из базы данных.

Свойства:
НазваниеТипПо умолчанию
$entityobject|string
Возвращает:
array

Массив объектов сущности, извлеченных из базы данных. Если данных в хранилище нет, возвращается пустой массив.

getManager

public getManager() : \Cycle\ORM\EntityManager
Возвращает:
\Cycle\ORM\EntityManager

getOrm

public getOrm() : \ORM\ORM
Краткое содержание

Возвращает экземпляр ORM, создавая его при необходимости.

Описание

Данный метод вызывает generateOrm, который инициализирует ORM, используя настраиваемые зависимости, такие как Schema, Factory, Container и CommandGenerator. Повторные вызовы возвращают уже созданный экземпляр ORM.

Ошибки:
ТипОписание
\RuntimeExceptionЕсли при генерации ORM возникли ошибки.
Возвращает:
\ORM\ORM

Экземпляр ORM.

paginate

public paginate(object|string  entity, string  orderby, string  sortby = 'DESC', int  limit = 10, int  page = 1) : \ORM\Select
Краткое содержание

Пагинирует данные из базы данных для указанной сущности.

Описание

Этот метод извлекает данные для заданной сущности, применяет сортировку и пагинацию на основе переданных параметров и возвращает настроенный объект ORM\Select.

Свойства:
НазваниеТипПо умолчанию
$entityobject|string
$orderbystring
$sortbystring'DESC'
$limitint10
$pageint1
Возвращает:
\ORM\Select

Настроенный объект Select, содержащий отсортированные и пагинированные данные.

query

public query(string  sql, array  params = []) : \StatementInterface
Краткое содержание

Выполняет SQL-запрос с указанными параметрами и возвращает результат.

Описание

Метод использует объект DatabaseManager для получения соединения с базой данных и дальнейшего выполнения SQL-запроса. Позволяет передавать параметры для безопасного выполнения подготовленных запросов.

Свойства:
НазваниеТипПо умолчанию
$sqlstring
$paramsarray[]
Ошибки:
ТипОписание
\InvalidArgumentExceptionМожет бросить исключение при передаче некорректного SQL-запроса.
\RuntimeExceptionМожет бросить исключение, если соединение с базой данных невозможно.
Возвращает:
\StatementInterface

Результирующий объект, представляющий результат выполнения запроса.

repository

public repository(object|string  entity) : \ORM\RepositoryInterface
Краткое содержание

Возвращает репозиторий для указанной сущности или класса сущности.

Описание

Эта функция принимает объект сущности или строку, представляющую имя класса сущности, определяет их имя класса и возвращает соответствующий репозиторий, используя ORM.

Свойства:
НазваниеТипПо умолчанию
$entityobjectstring
Ошибки:
ТипОписание
\ORM\Exception\RepositoryNotFoundExceptionЕсли репозиторий для указанной сущности не найден.
Возвращает:
\ORM\RepositoryInterface

Интерфейс репозитория для работы с указанной сущностью.

run

public run(object  entity) : \ORM\Transaction\StateInterface
Краткое содержание

Выполняет сохранение сущности и возвращает состояние транзакции.

Описание

Этот метод обрабатывает сохранение переданного объекта сущности с использованием связанного EntityManager. Завершает операцию методом run(), который выполняет транзакцию и возвращает её результирующее состояние.

Свойства:
НазваниеТипПо умолчанию
$entityobject
Ошибки:
ТипОписание
\RuntimeException|\ThrowableИсключение выбрасывается, если EntityManager не был корректно инициализирован, что приводит к ошибке сохранения.
Возвращает:
\ORM\Transaction\StateInterface

Результирующее состояние транзакции после сохранения сущности.

setManager

public setManager() : void
Краткое содержание

Устанавливает экземпляр EntityManager на основе текущего ORM.

Описание

Метод инициализирует объект EntityManager (менеджера для управления сущностями) на основе существующего объекта ORM (Object-Relational Mapping). Если ORM не был предварительно сконфигурирован, это может привести к выбросу ошибок в процессе создания EntityManager.

Ошибки:
ТипОписание
\RuntimeExceptionЕсли объект ORM не был предварительно создан.
Возвращает:
void

update

public update(object  entity) : \ORM\Transaction\StateInterface
Краткое содержание

Обновляет предоставленную сущность в базе данных.

Описание

Эта функция выполняет процесс обновления сущности посредством вызова метода run, который предполагает выполнение различных ORM-операций, таких, как persist.

Свойства:
НазваниеТипПо умолчанию
$entityobject
Ошибки:
ТипОписание
\ORM\Exception\EntityNotManagedExceptionЕсли сущность не управляется текущим менеджером сущностей.
\ORM\Exception\TransactionException|\ThrowableЕсли транзакция не может быть завершена.
Возвращает:
\ORM\Transaction\StateInterface

Возвращает состояние ORM-транзакции после обновления сущности.

compileSchema

private compileSchema(\Registry  registry) : array
Краткое содержание

Генерирует и компилирует схему на основе переданного реестра и генераторов схем.

Описание

Этот метод обрабатывает пути моделей с использованием глобального объекта $MIGRATOR, находит классы и использует их для генерации комплексной схемы базы данных. Примечание: Метод использует глобальную переменную $MIGRATOR, поэтому убедитесь, что она правильно инициализирована до вызова метода.

Свойства:
НазваниеТипПо умолчанию
$registry\Registry
Ошибки:
ТипОписание
\LogicExceptionЕсли при компиляции схемы возникли логические ошибки.
\RuntimeExceptionЕсли невозможно найти файлы моделей или извлечь классы.
Возвращает:
array

Возвращает скомпилированную схему в виде массива.

generateManager

private generateManager() : \DatabaseManager
Краткое содержание

Создает и возвращает экземпляр класса DatabaseManager.

Описание

Если объект orm_manager еще не создан, метод инициирует новый объект DatabaseManager на основе конфигурации ORM, полученной из метода generateOrmConfig.

Смотри так-же:
Ошибки:
ТипОписание
\RuntimeExceptionГенерируется, если не удается подключить необходимый файл конфигурации базы данных.
\ConfigExceptionГенерируется, если конфигурация базы данных содержит ошибки.
Возвращает:
\DatabaseManager

Экземпляр менеджера базы данных, конфигурированного с помощью ORM.

generateOrm

private generateOrm() : \ORM\ORM
Краткое содержание

Создает и возвращает экземпляр ORM (Object-Relational Mapper), используя предварительно скомпилированную схему, фабрику ORM, менеджер базы данных, а также генератор команд с поддержкой событий. Если ORM уже инициализирован, то возвращает ранее созданный объект.

Описание

Генерация ORM основывается на схеме, созданной методом {@see}, которой, в свою очередь, необходим зарегистрированный реестр сущностей. Управление базой данных осуществляется через метод {@see}.

Ошибки:
ТипОписание
\RuntimeExceptionЕсли генерация схемы или конфигурации базы данных завершилась с ошибкой.
Возвращает:
\ORM\ORM

Объект ORM (Object-Relational Mapper), предназначенный для взаимодействия с базой данных.

generateOrmConfig

private generateOrmConfig() : \Config\DatabaseConfig
Краткое содержание

Генерирует и возвращает объект конфигурации базы данных ORM, если он ещё не создан.

Описание

Функция проверяет, был ли ранее инициализирован объект конфигурации ORM. Если объект отсутствует, производится его создание на основании глобальных настроек. Подключается файл конфигурации базы данных и выполняется подготовка данных, таких как разбиение хоста и порта, а также выборка префикса таблиц в зависимости от типа базы данных.

Возвращает:
\Config\DatabaseConfig

Объект конфигурации базы данных ORM.

Класс: MhAjax

Документация по плагину класс: mhajax для DLE.

Класс: MhLog

Документация по плагину класс: mhlog для DLE.

On this page

Краткое содержание:СвойстваМетодыПодробностиСвойстваprivate $em : ?\Cycle\ORM\EntityManagerprivate $orm : ?\Cycle\ORM\ORMprivate $orm_config : ?\Cycle\Database\Config\DatabaseConfigprivate $orm_manager : ?\Cycle\Database\DatabaseManagerprivate $user_db : boolМетоды__constructКраткое содержаниеОписаниеСвойства:Ошибки:Возвращает:countКраткое содержаниеОписаниеСвойства:Возвращает:createКраткое содержаниеОписаниеСвойства:Ошибки:Возвращает:deleteКраткое содержаниеОписаниеСвойства:Ошибки:Возвращает:getКраткое содержаниеСвойства:Возвращает:getAllКраткое содержаниеОписаниеСвойства:Возвращает:getManagerВозвращает:getOrmКраткое содержаниеОписаниеОшибки:Возвращает:paginateКраткое содержаниеОписаниеСвойства:Возвращает:queryКраткое содержаниеОписаниеСвойства:Ошибки:Возвращает:repositoryКраткое содержаниеОписаниеСвойства:Ошибки:Возвращает:runКраткое содержаниеОписаниеСвойства:Ошибки:Возвращает:setManagerКраткое содержаниеОписаниеОшибки:Возвращает:updateКраткое содержаниеОписаниеСвойства:Ошибки:Возвращает:compileSchemaКраткое содержаниеОписаниеСвойства:Ошибки:Возвращает:generateManagerКраткое содержаниеОписаниеСмотри так-же:Ошибки:Возвращает:generateOrmКраткое содержаниеОписаниеОшибки:Возвращает:generateOrmConfigКраткое содержаниеОписаниеВозвращает: