phphleb/adminpan

Simple and adaptive Admin Panel from PHP Framework HLEB2

dev-master 2024-01-29 16:15 UTC

Requires

• php: >=8.2.0
• phphleb/framework: >=2.0.0

MIT

• Foma Tuturov

• adminpanel
• hleb2

README

Установка при помощи Composer:

composer require phphleb/adminpan

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

С помощью этой библиотеки создан внешний вид сайта документации фреймворка без значительных изменений.

Настройка

Если выполнить следующую команду, то в раздел /config/structure/ будет скопирован файл adminpan.php с описанием того, как создать структуру меню для административной панели.

php console phphleb/adminpan add

Первоначально файл /config/structure/adminpan.php содержит пустой массив, никаких разделов меню не задано. Разделы меню назначаются по названиям маршрутов (или обычным ссылкам). Пример для демонстрационного маршрута:

Route::get('/{lang}/panel/page/default')
    ->page('adminpan', ExamplePanelController::class)
    ->name('adminpan.default');

Здесь указано, что для меню 'adminpan' (одноименное с файлом adminpan.php) по URI адресу '/{lang}/panel/page/default' назначен контроллер page() класса ExamplePanelController для метода 'index'. Кроме того, маршрут имеет название 'adminpan.default', которое нужно для сопоставления с разделом в меню. Теперь можно создать первый пункт меню в файле /config/structure/adminpan.php.

return [
    'design' => 'base', // base|light... default `base`
    'breadcrumbs' => 'on', // on|off default 'on'
    'section' => [
        [
            'name' => [
                'ru' => 'Главное меню',
                'en' => 'Main menu'
            ],
            'section' => [
                [
                    'route' => 'adminpan.default',
                    'name' => [
                        'en' => 'Test page',
                        'ru' => 'Тестовая страница',
                    ],
                ],
            ],
        ],
    ]
];

Меню может содержать вложенные раскрывающиеся списки ('section'), сейчас назначен только один с одним пунктом.

Если перейти по адресу URL '/ru/panel/page/default', то для страницы будет назначен дизайн 'base'(из настроек), а также меню, в котором будет список 'Главное меню' c активным пунктом 'Тестовая страница' на которой будет выведен контент из контроллера ExamplePanelController.

Таким образом можно создать достаточно расширенное меню для сайта или админпанели, которое будет мультиязычным и интерактивным.

Совместно используя с библиотекой HLOGIN маршруты админпанели могут быть доступны только определенному типу пользователей (авторизованным).