Где лежат страницы конфигураций
Свои страницы размещаются в каталоге сайта /local/bik.rest/admin/pages/, по одному PHP-файлу на страницу (например, CustomPage.php). В файле — класс-наследник абстрактного класса AbstractPage с методами setTitle, setIcon, setTabs и setOptions; за основу возьмите пример ниже. Созданная страница появится в админке: Сервисы -> BIK.REST.
Страница или подмодуль
Обе точки расширения описывают вкладки и поля одинаково, но лежат в разных каталогах и показываются в разных местах админки:
| Страница конфигураций | Подмодуль | |
|---|---|---|
| Каталог | /local/bik.rest/admin/pages/ | /local/bik.rest/modules/ |
| Базовый класс | AbstractPage | AbstractModule |
| Где виден в админке | Сервисы -> BIK.REST | Настройки -> Настройки модулей -> BIK.REST -> Модули |
| Методы класса в примере | setTitle, setIcon, setTabs, setOptions | те же и ещё setID, setDescription |
Значения полей страницы читаются так же, как настройки модуля: \Bitrix\Main\Config\Option::get('bik.rest', 'код из setName'). Тип поля задаёт setInputType: PageOption::INPUT, PageOption::SELECT или PageOption::TEXTAREA.
Пример страницы
<?php
namespace BIK\Rest\Admin\Pages;
use BIK\Rest\Admin\Core\AbstractPage;
use BIK\Rest\Admin\Core\IconCollection;
use BIK\Rest\Admin\Core\PageOption;
use BIK\Rest\Admin\Core\PageOptionList;
use BIK\Rest\Admin\Core\PageTabList;
class CustomPage extends AbstractPage
{
/*
* Заголовок страницы и пункта меню
*/
public static function setTitle(): string
{
return "Custom Page";
}
/*
* Иконка пункта меню
*
* Функция должна возвращать css класс иконки; если иконка не требуется, можно вернуть пустую строку
* Класс IconCollection включает в себя набор css классов стандартных иконок, которые используются в Bitrix
*/
protected static function setIcon(): string
{
return IconCollection::SALE_CRM_SITE_MASTER_ICON;
}
/*
* Вкладки страницы
*
* Функция должна возвращать объект PageTabList
* Для добавления вкладки необходимо создать объект класса PageTabList и вызвать метод add, передав в качестве аргумента ID вкладки и её заголовок
*/
protected static function setTabs(): PageTabList
{
$list = new PageTabList();
$list
->add("base", "TAB 1")
->add("system", "TAB 2");
return $list;
}
/*
* Список конфигураций
*
* Каждая вкладка может содержат список своих конфигураций
* Функция должна возвращать объект PageOptionList
*
* Для добавления конфигурации необходимо создать объект класса PageOptionList и вызвать метод add
* Метод add принимает в качестве первого аргумента ID вкладки, указанный ранее в методе setTabs, и вторым аргументом - объект класса PageOption
*
* Объект PageOption
* setTitle - задает заголовок конфигурации, обязательный метод
* setInputType - задает тип поля, можно использовать PageOption::INPUT, PageOption::SELECT, PageOption::TEXTAREA, обязательный метод
* setName - задает уникальный идентификатор, обязательный метод
* setHint - задает подсказку, необязательный метод
* setDefaultValue - задает значение по умолчанию, необязательный метод
* setSelectOptions - задает список option для типа select(PageOption::SELECT), обязательный метод
*
* К значениям созданных конфигурации можно получить доступ так: \Bitrix\Main\Config\Option::get('bik.rest', 'уникальный идентификатор из setName');
*/
protected static function setOptions(): PageOptionList
{
$optionList = new PageOptionList();
return $optionList
->add("base",
(new PageOption())
->setTitle('Первая конфигурация:')
->setInputType(PageOption::INPUT)
->setName('config_one')
->setHint("Подсказка здесь")
->setDefaultValue(0)
)
->add("base",
(new PageOption())
->setTitle('Вторая конфигурация')
->setInputType(PageOption::SELECT)
->setName('config_two')
->setSelectOptions([
0 => 'Нет',
1 => 'Да',
])
->setDefaultValue(0)
)
->add("base",
(new PageOption())
->setTitle('Третья конфигурация')
->setInputType(PageOption::TEXTAREA)
->setName('config_three')
)
->add("system",
(new PageOption())
->setTitle('Четвертая конфигурация')
->setInputType(PageOption::INPUT)
->setName('config_four')
);
}
}