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

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

Документация по плагину содержание классов для разработки в back-end для DLE.

Трейты

НазваниеКраткое содержание
\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-ответ.
\TextLimiterTwig-расширение, предоставляющее инструмент для ограничения длины текста.
\TwigFilterКласс для создания и обработки фильтров данных, а также для работы с сортировкой и стандартными фильтрами для шаблонов.

Константы

MH_INIT

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

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

define("MH_INIT", true);

MH_ROOT

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

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

MH_LOCALES

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

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

MH_LOCALES

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

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

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

MH_MODULES

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

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

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

MH_INCLUDES

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

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

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

MH_CONFIG

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

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

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

MH_TEMPLATES

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

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

COMPOSER_DIR

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

define("COMPOSER_DIR", MH_INCLUDES . '/composer');

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

__

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

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

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

Описание

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

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

Свойства:

НазваниеТипПо умолчанию
$phrasestring
$paramsarray[]
$countint0

Ошибки:

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

Возвращает:

string

Переведённая строка.

br2nl

 br2nl(string  string, string  separator = PHP_EOL) : string

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

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

Описание

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

Свойства:

НазваниеТипПо умолчанию
$stringstring
$separatorstringPHP_EOL

Ошибки:

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

Возвращает:

string

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

clearfilepath

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

Свойства:

НазваниеТипПо умолчанию
$filemixed
$extmixed[]

Возвращает:

string

dirToArray

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

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

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

Описание

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

Свойства:

НазваниеТипПо умолчанию
$dirstring
$ignoredExtensionsarray[]

Ошибки:

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

Возвращает:

array

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

execute_query

 execute_query(mixed  id, mixed  query) : void

Свойства:

НазваниеТипПо умолчанию
$idmixed
$querymixed

Возвращает:

void

translate

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

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

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

Описание

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

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

Свойства:

НазваниеТипПо умолчанию
$phrasestring
$paramsarray[]
$countint0

Ошибки:

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

Возвращает:

string

Переведённая строка.

On this page