ZoomX. Создание плагинов для Smarty

Smarty из коробки содержит несколько модификаторов и кастомных функций. Но, конечно, их не хватит на все случаи в жизни. Поэтому придётся расширять этот список. Делается это через плагины. С помощью них вы можете создать свои модификаторы, функции, блоки, функции для компилятора, фильтры (pre и post) и ресурсы. Подключаются они двумя способами:

• автоматически (Smarty сам подключает нужный файл плагина по требованию);
• динамически (вы сами должны подключить плагин или фильтр через специальные методы registerPlugin() и registerFilter()).

Файловые плагины

Мне кажется, это самый простой способ. Нужно создать файл в папке с плагинами Smarty. У ZoomX уже есть папка плагинов, в которой находятся Smarty плагины для MODX. Можно создавать файлы в ней. Или выбрать другое место. В этом случае необходимо указать этот путь в системной настройке zoomx_custom_plugin_dir. Но тут есть важная тонкость. Для того, чтобы Smarty его увидел, файл нужно назвать в соответствии с определёнными правилами, описанными в документации — сначала указывается тип плагина (function, modifier, block и т.д.), затем точка, дальше название, которое будет использоваться в шаблоне, и заканчивается всё расширением php. Т.е. для модификатора chunk это должно выглядеть так — modifier.chunk.php.

После того, как файл создали, в нём нужно объявить функцию, у которой название также должно формироваться по следующему правилу — smarty_тип плагина_название. Для нашего примера функция будет называться smarty_modifier_chunk. Теперь, если модификатор chunk будет указан в шаблоне, то Smarty автоматически его подгрузит.

Давайте для примера создадим модификатор, который работает как FastField (когда можно вызывать поля указанного ресурса, а не только текущего). Поэтому заглянем в документацию и посмотрим на синтаксис именно для модификаторов.

Мы пойдём другим путём — создадим отдельный модификатор. Назовём его коротко — field. За основу возьмём плагин модификатора resource. Файл назовём соответственно modifier.field.php. Сама функция получится такой:

<?php
/*
 * Smarty plugin
 * -------------------------------------------------------------
 * Файл:    modifier.field.php
 * Тип:     modifier
 * Имя:     field
 * Назначение:  Get a field of the specified resource.
 * -------------------------------------------------------------
 */
function smarty_modifier_field($id, $field)
{
    global $modx;

    $id = (int)$id;
    if ($id && $resource = $modx->getObject('modResource', ['id' => $id])) {
        return $resource->{$field};
    }

    return null;
}

Ну и теперь вызываем его в шаблоне — получим поле pagetitle ресурса с id=5.

{5|field:"pagetitle"}
// Можно вернуть дефолтное значение
{5|field:"pagetitle"|default:"Ресурс не найден!"}

Динамические плагины

Тут уже никакой магии не будет — придётся создать плагин на событие OnModxInit (можно и на OnHandleRequest) и в нём добавить функцию Smarty плагина. Никакие правила именования тут уже не нужны. Для примера добавим тот же модификатор field.

<?php
// Плагин
// Событие OnModxInit

if ($modx->context->key !== 'mgr') {
    function fieldModifier($id, $field)
    {
        global $modx;
    
        $id = (int)$id;
        if ($id && $resource = $modx->getObject('modResource', ['id' => $id])) {
            return $resource->{$field};
        }
    
        return null;
    }

    // Регистрируем функцию модификатора
    $smarty = parserx();
    $smarty->registerPlugin("modifier","field", "fieldModifier");
}

Таким же образом можно регистрировать функции, блоки и т.д.

Заключение

Лично мне удобнее первый вариант — раз мы отказались от элементов в БД, то зачем опять начинать. Вся разработка в IDE редакторе. В PhpStorm есть полноценная поддержка Smarty. Поэтому кодить достаточно приятно и удобно.