Класс: AdminContext¶
Краткое содержание:¶
Контекст административной панели для текущего запроса модуля.
Свойства¶
- public $dashboardName
- public $licenseAgreementLink
Методы¶
- public __construct()
- public forPlugin()
- public setCurrentAction()
- public currentAction()
- public menu()
- public breadcrumbs()
- public author()
- public url()
- public licLink()
- public addBreadcrumb()
- public finalizeBreadcrumbs()
- public addCss()
- public addJs()
- public cssUrls()
- public jsUrls()
- public toArray()
- private resolveSiteUrl()
- private baseCssUrls()
- private baseJsUrls()
Подробности¶
- Путь:
devcraft/src/classes/Admin/AdminContext.php
Детали¶
Свойства¶
$dashboardName¶
Контекст административной панели для текущего запроса модуля.
$licenseAgreementLink¶
Ссылка на пользовательское соглашение между автором и пользователем. По умолчанию: https://devcraft.club/pages/licence-agreement/
Методы¶
__construct()¶
Создаёт контекст админки для указанного модуля.
С версии: 200.4.0
Параметры: - $plugin — Контекст модуля.
forPlugin()¶
Фабричный метод создания контекста для модуля.
С версии: 200.4.0
Параметры: - $plugin — Контекст модуля.
Возвращает: self — Новый экземпляр контекста.
setCurrentAction()¶
Устанавливает текущее действие админки.
С версии: 200.4.0
Параметры: - $action — Имя действия.
Возвращает: self — Текущий экземпляр для цепочки вызовов.
currentAction()¶
Возвращает текущее действие админки.
С версии: 200.4.0
Возвращает: string — Имя действия.
menu()¶
Возвращает меню админки.
С версии: 200.4.0
Возвращает: AdminLink[] — Список корневых пунктов меню.
breadcrumbs()¶
Возвращает хлебные крошки страницы.
С версии: 200.4.0
Возвращает: BreadCrumb[] — Список крошек.
author()¶
Возвращает данные автора модуля.
С версии: 200.4.0
Возвращает: Author — Объект автора.
url()¶
Возвращает базовый URL сайта.
С версии: 200.4.0
Возвращает: string — URL без завершающего слэша.
licLink()¶
Возвращает ссылку на лицензионное соглашение.
С версии: 200.4.0
Возвращает: string — URL соглашения.
addBreadcrumb()¶
Добавляет хлебную крошку в конец списка.
С версии: 200.4.0
Параметры: - $title — Заголовок крошки. - $url — Необязательная ссылка.
Возвращает: self — Текущий экземпляр для цепочки вызовов.
finalizeBreadcrumbs()¶
Дополняет крошки ссылкой на dashboard и сохраняет крошки страницы.
С версии: 200.4.0
Параметры: - $mod — Имя модуля. - $action — Текущее действие.
addCss()¶
Регистрирует дополнительный CSS-файл.
С версии: 200.4.0
Параметры: - $url — URL стиля.
Возвращает: self — Текущий экземпляр для цепочки вызовов.
addJs()¶
Регистрирует дополнительный JS-файл.
С версии: 200.4.0
Параметры: - $url — URL скрипта.
Возвращает: self — Текущий экземпляр для цепочки вызовов.
cssUrls()¶
Возвращает список URL CSS-файлов.
С версии: 200.4.0
Возвращает: string[] — URL стилей.
jsUrls()¶
Возвращает список URL JS-файлов.
С версии: 200.4.0
Возвращает: string[] — URL скриптов.
toArray()¶
Преобразует контекст в массив для передачи в Twig.
С версии: 200.4.0
Возвращает: array<string, — mixed> Ассоциативный массив данных layout.
resolveSiteUrl()¶
Определяет базовый URL сайта из глобальной конфигурации DLE.
С версии: 200.4.0
Возвращает: string — URL без завершающего слэша.
baseCssUrls()¶
Формирует базовый список CSS DevCraft.
С версии: 200.4.0
Возвращает: string[] — URL стилей Metro и DevCraft.
baseJsUrls()¶
Формирует базовый список JS DevCraft.
С версии: 200.4.0
Возвращает: string[] — URL скриптов Metro и DevCraft.