Перейти к содержанию

Содержание классов для разработки в Back-End

Трейты

Название Краткое содержание
\AssetsChecker Трейт для проверки и управления ассетами (файлы скриптов и стилей).
\DataLoader Трейт для загрузки данных с использованием кеша или базы данных.
\DleData Трейт DleData предоставляет методы для работы с дополнительными данными (xfields), пользователями, группами, категориями и другими сущностями в контексте системы управления данными.
\UpdatesChecker Трейт UpdatesChecker предоставляет функции для работы с информацией об обновлениях ресурсов.

Классы

Название Краткое содержание
\Admin Класс Admin предназначен для управления административной панелью проекта.
\AdminLink Класс AdminLink реализует функциональность для создания и управления административными ссылками, включая родительские связи, дочерние элементы, типы ссылок и дополнительные параметры.
\AdminUrlExtension Класс предоставляет функции и глобальные переменные для использования в Twig-шаблонах.
\AjaxAbstractResponse Абстрактный класс, представляющий базовый ответ в виде JSON.
\Author Класс, представляющий автора с именем, списком контактов и пожертвований.
\BasisModel Базовый абстрактный класс модели, представляющий типовую сущность базы данных.
\BasisRepository Базовый репозиторий для работы с сущностями.
\BreadCrumb Класс, представляющий хлебную крошку для навигации.
\CacheControl Абстрактный класс для реализации управления кэшированием.
\ComposerAction
\DataManager Абстрактный класс DataManager, представляющий базовый функционал для менеджеров данных.
\DateTimeFormatter Расширение Twig для работы с форматированием даты и времени.
\DeclineExtension Склонение слова в зависимости от числа.
\ErrorResponseAjax Класс для формирования ответов об ошибке.
\LogGenerator Абстрактный класс для управления процессом логирования. Класс включает в себя базовый функционал для записи логов в файлы, базу данных и отправки уведомлений в Telegram.
\MhAjax Вспомогательный класс для работы с системой управления DLE
\MhDB Класс для работы с базой данных
\MhLog Базовый абстрактный класс модели, представляющий типовую сущность базы данных.
\MhLogRepository Базовый репозиторий для работы с сущностями.
\MhTranslation Класс для оформления фраз переводов
\MobileDetectExtension Расширение Twig, основанное на MobileDetect.
\SuccessResponseAjax Представляет успешный HTTP-ответ.
\TextLimiter Twig-расширение, предоставляющее инструмент для ограничения длины текста.
\TwigFilter Класс для создания и обработки фильтров данных, а также для работы с сортировкой и стандартными фильтрами для шаблонов.

Константы

COMPOSER_DIRECTORY

Text Only
1
COMPOSER_DIRECTORY = ENGINE_DIR . '/inc/maharder/_includes/composer'

MH_INIT

Определяет константу, используемую для инициализации системы.

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

Text Only
1
define("MH_INIT", true);

MH_ROOT

Константа MH_ROOT указывает на путь к директории engine/inc/maharder в структуре проекта. Этот путь формируется на основе значения константы ROOT_DIR, определяющей корневую директорию проекта. Константа используется для упрощённого доступа к базовой директории функционала Maharder.

Text Only
1
define("MH_ROOT", ROOT_DIR . '/engine/inc/maharder');

MH_LOCALES

Константа MH_ADMIN определяет путь к административной директории. Формируется путем объединения константы MH_ROOT с поддиректорией '/admin'.

Text Only
1
define("MH_ADMIN", MH_ROOT . '/admin');

MH_LOCALES

Константа, задающая путь к локализациям.

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

Text Only
1
define("MH_LOCALES", MH_ROOT . '/_locales');

MH_MODULES

Определяет константу MH_MODULES, указывающую на путь к папке модулей в корневой директории.

Константа используется для задания базового пути к директории с модулями, относительно константы MH_ROOT, которая должна быть определена ранее.

Text Only
1
define("MH_LOCALES", MH_ROOT . '/_modules');

MH_INCLUDES

Определяет константу MH_INCLUDES, содержащую путь к директории _includes внутри корневой директории.

Константа используется для централизованного указания пути к дополнительным включаемым файлам проекта. Значение формируется путем объединения значения константы MH_ROOT и строки /_includes.

Text Only
1
define("MH_LOCALES", MH_ROOT . '/_includes');

MH_CONFIG

Определяет путь к папке конфигурации приложения.

Константа MH_CONFIG содержит полный путь к директории _config, основываясь на значении корневой директории MH_ROOT

Text Only
1
define("MH_LOCALES", MH_ROOT . '/_config');

MH_TEMPLATES

Определяет константу MH_TEMPLATES, которая содержит путь к директории с шаблонами проекта. Значение пути формируется на основе константы MH_ROOT с добавлением поддиректории '_templates'.

Text Only
1
define("MH_LOCALES", MH_ROOT . '/_templates');

Функции / Методы

__

Text Only
1
 __(string  phrase, array  params = [], int  count) : string

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

Синоним функции перевода translate для упрощённого использования.

Описание

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

Смотри так-же:

Свойства:

Название Тип По умолчанию
$phrase string
$params array []
$count int 0

Ошибки:

Тип Описание
\Throwable

Возвращает:

Text Only
1
string
Переведённая строка.

br2nl

Text Only
1
 br2nl(string  string, string  separator = PHP_EOL) : string

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

Преобразует теги <br> в заданный разделитель строк.

Описание

Данная функция заменяет все теги <br> (включая различные его варианты, такие как <br>, <br/> и <br />) на указанный разделитель строк. Если переданный разделитель не входит в список допустимых значений, будет использован стандартный разделитель PHP_EOL.

Свойства:

Название Тип По умолчанию
$string string
$separator string PHP_EOL

Ошибки:

Тип Описание
\InvalidArgumentException Исключение выбрасывается, если входные данные недействительны или пустые.

Возвращает:

Text Only
1
string
Строка, в которой все <br> заменены на указанный разделитель.

clearfilepath

Text Only
1
 clearfilepath(mixed  file, mixed  ext = []) : string

Свойства:

Название Тип По умолчанию
$file mixed
$ext mixed []

Возвращает:

Text Only
1
string

dirToArray

Text Only
1
 dirToArray(string  dir, array  ignoredExtensions = []) : array

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

Преобразует заданный путь к директории в массив, содержащий дерево папок и файлов.

Описание

Эта функция позволяет получить структуру файловой системы в виде ассоциативного массива. Папки представлены в виде ключей, а файлы - в виде элементов массива. Также поддерживает возможность исключения определенных файлов и расширений.

Свойства:

Название Тип По умолчанию
$dir string
$ignoredExtensions array []

Ошибки:

Тип Описание
\RuntimeException Если scandir не удается получить содержимое директории.

Возвращает:

Text Only
1
array
Массив, представляющий собой дерево файловой структуры. Каждая директория содержит вложенные файлы/папки.

execute_query

Text Only
1
 execute_query(mixed  id, mixed  query) : void

Свойства:

Название Тип По умолчанию
$id mixed
$query mixed

Возвращает:

Text Only
1
void

translate

Text Only
1
 translate(string  phrase, array  params = [], int  count) : string

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

Переводит заданную фразу с использованием модуля перевода.

Описание

Если язык и путь для локалей не установлены в конфигурации, возвращает исходную фразу. В зависимости от переданных параметров, поддерживает как обрабатываемый, так и базовый перевод с использованием модулей MhTranslation. При возникновении ошибки логирует её и возвращает исходную фразу.

Смотри так-же:

Свойства:

Название Тип По умолчанию
$phrase string
$params array []
$count int 0

Ошибки:

Тип Описание
\Exception \Throwable

Возвращает:

Text Only
1
string
Переведённая строка.