Класс: MhLog
Документация по плагину класс: mhlog для DLE.
Краткое содержание:
Базовый абстрактный класс модели, представляющий типовую сущность базы данных.
Описание:
Класс используется для создания типовых моделей с общими свойствами, такими как
уникальный идентификатор (id), дата создания (createdAt) и дата последнего обновления (updatedAt).
Предназначен для расширения в конкретных классах моделей, которые реализуют бизнес-логику
и определяют дополнительные свойства и методы.
Свойства:
id— уникальный первичный ключ записи.createdAt— дата и время создания записи.updatedAt— дата последнего обновления записи (null, если данных об изменениях нет).
Методы:
Класс предоставляет доступные методы для получения базовой информации о записи:
getId()— возвращает уникальный идентификатор сущности.getCreatedAt()— возвращает дату и время создания записи.getUpdatedAt()— возвращает дату последнего обновления или null, если обновления не было.getColumnVal(string $name)— возвращает значение конкретного столбца по его имени (реализуется в наследниках).
Аннотации:
Класс использует аннотации для указания схемы базы данных с помощью библиотеки Cycle ORM.
Например:
#[Column()]определяет параметры поля таблицы.#[Index()]задаёт индексированные столбцы (например,created_atдля быстрого поиска).
Расширяемость:
- Класс абстрактный. Для его использования необходимо создать наследника и, как минимум,
реализовать метод
getColumnVal(), который позволяет получить значение столбца.
Свойства
- protected $createdAt
- protected $id
- protected $updatedAt
- private $fn_name
- private $log_type
- private $message
- private $plugin
- private $time
- private $uuid
Методы
- public getColumnVal()
- public getCreatedAt()
- public getFnName()
- public getId()
- public getLogType()
- public getMessage()
- public getPlugin()
- public getTime()
- public getUpdatedAt()
- public getUuid()
- public setFnName()
- public setLogType()
- public setMessage()
- public setPlugin()
- public setTime()
- public setUuid()
Подробности
- Путь: engine/inc/maharder/_modules/admin/models/MhLog.php
Свойства
protected $createdAt : \DateTimeImmutable
Краткое содержание
Дата и время создания записи. Автоматически проставляется при создании.
Тип: \DateTimeImmutable
Подробности:
- Унаследовано от: \BasisModel
protected $id : int
Краткое содержание
ID сущности (уникальный первичный ключ).
Тип: Целое число
Подробности:
- Унаследовано от: \BasisModel
protected $updatedAt : ?\DateTimeImmutable
Краткое содержание
Дата и время последнего обновления записи. Может быть равна null.
Описание
Автоматически обновляется при изменении записи.
Тип: Дата и время или null
Подробности:
- Унаследовано от: \BasisModel
private $fn_name : string
Тип: Текст
private $log_type : string
Тип: Текст
private $message : string
Тип: Текст
private $plugin : string
Тип: Текст
private $time : \DateTimeImmutable
Тип: \DateTimeImmutable
private $uuid : \Ramsey\Uuid\UuidInterface
Тип: \Ramsey\Uuid\UuidInterface
Подробности:
Методы
getColumnVal
public getColumnVal(string name) : mixedКраткое содержание
Получить значение столбца по его имени.
Свойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $name | string |
Возвращает:
mixedЗначение столбца.
getCreatedAt
public getCreatedAt() : \DateTimeImmutableКраткое содержание
Получить дату и время создания записи.
Возвращает:
\DateTimeImmutableДата и время создания записи.
getFnName
public getFnName() : stringВозвращает:
stringgetId
public getId() : intКраткое содержание
Получить уникальный идентификатор сущности.
Возвращает:
intУникальный идентификатор сущности.
getLogType
public getLogType() : stringВозвращает:
stringgetMessage
public getMessage() : stringВозвращает:
stringgetPlugin
public getPlugin() : stringВозвращает:
stringgetTime
public getTime() : \DateTimeImmutableВозвращает:
\DateTimeImmutablegetUpdatedAt
public getUpdatedAt() : \DateTimeImmutable|nullКраткое содержание
Получить дату и время последнего обновления записи, если доступно.
Возвращает:
\DateTimeImmutable|nullДата и время последнего обновления или null, если обновления не было.
getUuid
public getUuid() : \Ramsey\Uuid\UuidInterfaceВозвращает:
\Ramsey\Uuid\UuidInterfacesetFnName
public setFnName(string fn_name) : voidСвойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $fn_name | string |
Возвращает:
voidsetLogType
public setLogType(string log_type) : voidСвойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $log_type | string |
Возвращает:
voidsetMessage
public setMessage(string message) : voidСвойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $message | string |
Возвращает:
voidsetPlugin
public setPlugin(string plugin) : voidСвойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $plugin | string |
Возвращает:
voidsetTime
public setTime(\DateTimeImmutable time) : voidСвойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $time | \DateTimeImmutable |
Возвращает:
voidsetUuid
public setUuid(\Ramsey\Uuid\UuidInterface uuid) : voidСвойства:
| Название | Тип | По умолчанию |
|---|---|---|
| $uuid | \Ramsey\Uuid\UuidInterface |
Возвращает:
void