Инициализация модуля (класс Init)

Файл Init/Init.php является самым главным конфигурационным файлом. Он обязательно должен унаследоваться от Okay\Core\Modules\AbstractInit. В классе Init должны быть реализованы методы install() и init(). Базовый класс Okay\Core\Modules\AbstractInit предоставляет средства для инициализации модуля в системе. Метод install() выполняется один раз, во время установки модуля, метод init() вызывается при каждом запуске системы.

Методы класса AbstractInit

registerChainExtension( array $expandable, array $extension)

Регистрирует экстендер в режиме Chain. Вызывать в методе init().

Аргумент	Описание
$expandable	массив из двух элементов, имени класса хелпера или реквеста и его метода, который нужно расширить.
$extension	массив из двух элементов, имени класса экстендера и его метода, каким нужно расширить метод хелпера.

registerQueueExtension( array $expandable, array $extension)

Регистрирует экстендер в режиме Queue. Вызывать в методе init().

Аргумент	Описание
$expandable	массив из двух элементов, имени класса хелпера или реквеста и его метода, который нужно расширить.
$extension	массив из двух элементов, имени класса экстендера и его метода, каким нужно расширить метод хелпера.

migrateEntityTable( string $entityClassName, array $fields)

Создание таблицы нового Entity модуля. Пример миграции. Вызывать в методе install().

Аргумент	Описание
$entityClassName	полное имя класса Entity
$fields	массив экземпляров класса Okay\Core\Modules\EntityField

migrateEntityField( string $entityClassName, EntityField $field)

Добавление дополнительных полей в БД к существующим сущностям. Вызывать в методе install().

Аргумент	Описание
$entityClassName	полное имя существующего класса Entity
$field	экземпляр класса Okay\Core\Modules\EntityField

migrateCustomTable( string $tableName, array $fields)

Создание таблицы в БД. В основном используется для создания таблиц связей. Вызывать в методе install().

Аргумент	Описание
$tableName	название таблицы, которую нужно создать (без префиксов "ok_" или "__")
$fields	массив экземпляров класса Okay\Core\Modules\EntityField

registerEntityField( string $entityClassName, string $fieldName[, bool $isLang = false])

Регистрация дополнительных полей к существующим сущностям. В базу не добавляются, только учавствуют в селекте и фильтрации. Вызывать в методе init().

Аргумент	Описание
$entityClassName	Полное имя класса существующего Entity
$fieldName	Название колонки, которую стоит добавить в Entity
$isLang	является ли это поле ленговым

registerEntityFilter( string $entityClassName, string $filterName, string $filterClassName, string $filterMethod)

Регистрация пользовательского фильтра для уже существующих в системе Entities. Вызывать в методе init().

Аргумент	Описание
$entityClassName	Полное имя класса существующего Entity, для которого регистрируется новый фильтр
$filterName	Имя нового фильтра, которое будет использоваться в массиве совместно с остальными фильтрами
$filterClassName	Класс, в котором описана реализация нового фильтра
$filterMethod	Метод описывающий реализацию нового фильтра

registerBackendController( string $controllerClass)

Добавление бек-контроллера в общий список контроллеров. Вызывать в методе init().

Аргумент	Описание
$controllerClass	Имя класса бек-контроллера

setBackendMainController( string $className)

Установка бек-контроллер, который будет в админке обрабатываться как основной (когда со списка модулей происходит переход внутрь модуля, попадаем на этот контроллер). Вызывать в методе install().

Аргумент	Описание
$className	Имя класса бек-контроллера

addBackendControllerPermission( string $controllerClass, string $permission)

Добавление связки разрешения для админа и бек-контроллера. Вызывать в методе init().

Аргумент	Описание
$controllerClass	Имя класса бек-контроллера
$permission	Название разрешения

addPermission( string $permission)

Добавление разрешения, в общий массив разрешений для менеджеров. Нужно использовать если нужно разрешение, но бек-контроллера для него нет. Вызывать в методе init().

Аргумент	Описание
$permission	Название разрешения

setModuleType( string $type)

Установка типа модуля. Вызывать в методе install().

Аргумент	Описание
$type	Тип модуля. Константы типов начинаются на MODULE_TYPE_. Типы модулей.

extendBackendMenu( string $firstLevelName, array $menuItemsByControllers[, string $icon = null])

Добавить новый пункт меню в админ-части. Вызывать в методе init().

Аргумент	Описание
$firstLevelName	Название группы меню, в которую стоит добавить новый пункт. Если указать несуществующую группу, тогда создастся новая.
$menuItemsByControllers	Массив, в котором ключ является названием пункта меню, и должен быть перевод с таким же названием. В виде значения должен быть массив названий бек-контроллеров, которые будут в этом пункте меню (обычно это контроллер списка записей и редактирования одной записи).
$icon	Иконка группы меню. Стоит использовать если создаёте новую группу. В виде значения может быть код SVG изображения, или же путь к изображению, относительно директории `Okay/Modules/Vendor/Module/` (напр. 'Backend/design/images/menu_logo.png').

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

Пример Init:

$this->extendBackendMenu('left_faq_title', [
    'left_faq_menu_item' => ['FAQsAdmin', 'FAQAdmin']
],
'Backend/design/images/faq_icon.png');

Переводы:

$lang['left_faq_title'] = 'FAQ';
$lang['left_faq_menu_item'] = 'FAQ Item';

addResizeObject( string $originalImgDirDirective, string $resizedImgDirDirective)

Добавление ресайза сущностей. Если ваш модуль подразумевает что будут нарезаться изображения, которых в системе ранее не было, то нужно добавить в систему информацию об этом. Не забыть в таком случае еще в методе install создать директорию для изображений (через функцию mkdir()). Вызывать в методе init().

Аргумент	Описание
$originalImgDirDirective	Название директивы из конфига модуля, которая содержит путь к директории оригиналов изображений
$resizedImgDirDirective	Название директивы из конфига модуля, которая содержит путь к директории нарезок изображений

Пример Init:

class Init extends AbstractInit
{   
    public function install()
    {
        if (!is_dir('files/originals/slides')) {
            mkdir('files/originals/slides');
        }
        
        if (!is_dir('files/resized/slides')) {
            mkdir('files/resized/slides');
        }
        // ...abstract
    }
    
    public function init()
    {
        // ...abstract
        $this->addResizeObject('banners_images_dir', 'resized_banners_images_dir');
    }
}

Пример конфига:

banners_images_dir = files/originals/slides/
resized_banners_images_dir = files/resized/slides/

extendUpdateObject( string $alias, string $permission, string $entityClassName)

Метод расширяет коллекцию объектов доступную для использования в файле ajax/update_object.php, который обновляет определенную по алиасу сущность повредством AJAX запроса из админ панели сайта.

Аргумент	Описание
$alias	Уникальный псевдоним, который идентифицирует сущность (указывается в атрибуте data-controller="алиас" тега в админ панели)
$permission	Название разрешения доступа к псевдониму для менеджера, добавленые через addBackendControllerPermission или addPermission
$entityClassName	Полное имя сущности, которая будет обновляться.

Пример Init:

class Init extends AbstractInit
{
    const PERMISSION = 'okaycms_banners';
    // ...abstract
    public function init()
    {
        // ...abstract
        $this->addBackendControllerPermission('BannersAdmin', self::PERMISSION);
        $this->extendUpdateObject('okay_cms__banners', self::PERMISSION, BannersEntity::class);
    }
}

Пример banners.tpl (добавляем data-controller):

// ...abstract
{foreach $banners as $banner}
    <div class="fn_row okay_list_body_item fn_sort_item">
        <div class="okay_list_row">
            <div class="okay_list_boding okay_list_features_name">
                <a class="link" href="{url controller=[OkayCMS,Banners,BannerAdmin] id=$banner->id return=$smarty.server.REQUEST_URI}">
                    {$banner->name|escape}
                </a>
            </div>
            // ...abstract
            <div class="okay_list_boding okay_list_status">
                {*visible*}
                <div class="col-lg-4 col-md-3">
                    <label class="switch switch-default">
                        <input class="switch-input fn_ajax_action {if $banner->visible}fn_active_class{/if}" data-controller="okay_cms__banners" data-action="visible" data-id="{$banner->id}" name="visible" value="1" type="checkbox"  {if $banner->visible}checked=""{/if}/>
                        <span class="switch-label"></span>
                        <span class="switch-handle"></span>
                    </label>
                </div>
            </div>
        </div>
    </div>
{/foreach}
// ...abstract

addBackendBlock( string $blockName, string $blockTplFile)

Добавление шорт-блока в админ-панель сайта.

Аргумент	Описание
$blockName	Имя шорт-блока админ-панели.
$blockTplFile	Путь к tpl файлу (относительно директории `Okay/Modules/Vendor/Module/Backend/design/html/`), в котором размещается верстка блока. В блоке работаем, как будто его добавят в основной файл через include (все переменные поддерживаются).

addFrontBlock( string $blockName, string $blockTplFile)

Добавление шорт-блока на клиентскую часть сайта.

Аргумент	Описание
$blockName	Имя шорт-блока клиентской части сайта.
$blockTplFile	Путь к tpl файлу (относительно директории `Okay/Modules/Vendor/Module/design/html/`), в котором размещается верстка блока. В блоке работаем, как будто его добавят в основной файл через include (все переменные поддерживаются).

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

init.md

init.md

Инициализация модуля (класс Init)

Методы класса AbstractInit

Files

init.md

Latest commit

History

init.md

File metadata and controls

Инициализация модуля (класс Init)

Методы класса AbstractInit