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

Класс: PluginContext

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

Контекст одного DevCraft-модуля после загрузки manifest.php.

Свойства

Методы

Подробности

  • Путь: devcraft/src/classes/Module/PluginContext.php

Детали

Свойства

$settingsSchema

Контекст одного DevCraft-модуля после загрузки manifest.php.

Методы

__construct()

Создаёт контекст плагина из загруженного манифеста и пути к модулю.

С версии: 200.4.0

Параметры: - $mod — Идентификатор модуля в URL админки. - $modulePath — Абсолютный путь к каталогу модуля.

mod()

Возвращает идентификатор модуля (mod) для URL и конфигурации.

С версии: 200.4.0

Возвращает: string — Значение mod из манифеста или переопределения.

meta()

Возвращает блок meta манифеста с добавленным module_code.

С версии: 200.4.0

Возвращает: array<string, — mixed> Метаданные модуля для шаблонов.

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

С версии: 200.4.0

Возвращает: AdminLink[] — Ссылки меню из manifest.php.

pageClass()

Возвращает FQCN класса страницы для указанного action.

С версии: 200.4.0

Параметры: - $action — Имя action из URL.

Возвращает: string|null — FQCN класса страницы или null.

defaultAction()

Возвращает action страницы по умолчанию (start) для модуля.

С версии: 200.4.0

Возвращает: string|null — Имя action или null, если меню пусто.

settingsSchema()

Возвращает схему настроек модуля, если файл settings.schema.php существует.

С версии: 200.4.0

Возвращает: FormSchema|null — Схема полей или null.

filterSchema()

Возвращает схему фильтра для указанного action (например, «logs»).

С версии: 200.4.0

Параметры: - $action — Ключ action, для которого загружена схема фильтра.

Возвращает: FilterSchema|null — Схема фильтра или null.

ajaxMethods()

Возвращает карту зарегистрированных AJAX-методов модуля.

С версии: 200.4.0

Возвращает: array<string, — class-string> Имя метода => FQCN обработчика.

ajaxController()

Возвращает идентификатор AJAX-контроллера из манифеста.

С версии: 200.4.0

Возвращает: string — Значение ajax.controller (по умолчанию «admin»).

modulePath()

Возвращает абсолютный путь к корневому каталогу модуля.

С версии: 200.4.0

Возвращает: string — Путь к каталогу модуля на диске.

jsAssetFiles()

Возвращает список имён JS-файлов из секции assets.js манифеста.

С версии: 200.4.0

Возвращает: list<string> — Имена файлов относительно Public/.

moduleData()

Формирует объект ModuleData для реестра и шаблонов.

С версии: 200.4.0

Возвращает: ModuleData — Агрегированные метаданные модуля.

changelog()

Возвращает записи changelog модуля.

С версии: 200.4.0

Возвращает: Changelog[] — История изменений из changelog.data.php.

parseMenu()

Преобразует сырой массив menu из манифеста в объекты AdminLink.

С версии: 200.4.0

Возвращает: AdminLink[] — Только элементы типа AdminLink.

parseAjaxMethods()

Нормализует карту AJAX-методов из манифеста.

С версии: 200.4.0

Возвращает: array<string, — class-string> Валидные пары method => handler.

loadSchemas()

Загружает settings.schema.php и logs.filter.schema.php модуля при наличии.

С версии: 200.4.0