Настраиваемые TV переменные шаблона

Последнее обновление Oct 12th, 2026 | История страницы | Улучшить эту страницу | Сообщить о проблеме

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$194 per month—let's make that $500!

Learn more

Это руководство для MODX Revolution 3.x.

Что такое настраиваемые типы ввода TV?¶

MODX Revolution позволяет добавлять свои типы ввода для TV рядом с text, option, textarea, richtext и остальными (ключи типов лежат в core/lexicon/ru/tv_input_types.inc.php). Этот пример показывает выпадающий список шаблонов в менеджере, а на фронтенде печатает ID выбранного шаблона в div. Тип называется templateselect. Файлы лежат в Extra по пути core/components/ourtvs/.

Если кастомный рендерер не найден, MODX рисует обычное текстовое поле. Это запасной вариант в modTemplateVar::getRender(), а не сломанный combo. Чаще всего забыли плагин путей ниже.

Создайте пространство имён¶

Создайте Namespace с именем ourtvs и путём {core_path}components/ourtvs/.

В 3.x MODX ещё смотрит {namespace_path}/tv/input/, когда перечисляет типы ввода в редакторе TV, и {namespace_path}/tv/output/ — когда перечисляет типы вывода. Эти списки и отрисовка TV на ресурсе — разные шаги. Для отрисовки нужен плагин из следующего шага.

Создайте плагин путей¶

Плагин нужен и в 2.3, и в 3.x. Namespace его для формы ресурса не заменяет.

Создайте плагин OurTvsPlugin и повесьте только эти события:

OnTVInputRenderList — рендер ввода в менеджере
OnTVOutputRenderList — рендер вывода на фронтенде
OnTVInputPropertiesList — свойства ввода в менеджере
OnTVOutputRenderPropertiesList — свойства вывода

Код плагина:

$corePath = $modx->getOption('core_path').'components/ourtvs/';
switch ($modx->event->name) {
    case 'OnTVInputRenderList':
        $modx->event->output($corePath.'tv/input/');
        break;
    case 'OnTVOutputRenderList':
        $modx->event->output($corePath.'tv/output/');
        break;
    case 'OnTVInputPropertiesList':
        $modx->event->output($corePath.'tv/inputoptions/');
        break;
    case 'OnTVOutputRenderPropertiesList':
        $modx->event->output($corePath.'tv/properties/');
        break;
}

Путь из плагина используется как есть — имя каталога может быть любым. Две конвенции на выбор: автоскан неймспейсов для свойств ищет только в {namespace_path}/tv/inputproperties/ и {namespace_path}/tv/properties/, а плагин выше отдаёт tv/inputoptions/ — это работает, потому что путь плагина важнее скана.

Обработчики добавляют пути для include. Для OnTVInputPropertiesList и OnTVOutputRenderPropertiesList слеш в конце обязателен — путь склеивается как есть. Для OnTVInputRenderList и OnTVOutputRenderList в 3.x путь нормализуется, слеш там не важен. В 3.x события плагина подхватываются сразу после сохранения плагина — очищать кеш менеджера не нужно.

Без плагина тип может появиться в списке Input Type (в 3.x его подхватывает Namespace), но на форме ресурса останется текстовое поле.

Создайте контроллер ввода¶

Контроллер ввода грузит разметку. Создайте файл:

core/components/ourtvs/tv/input/templateselect.class.php

Имя файла без .class.php это ключ типа: templateselect.

<?php
if (!class_exists('TemplateSelectInputRender')) {
    class TemplateSelectInputRender extends modTemplateVarInputRender {
        public function getTemplate() {
            return $this->modx->getOption('core_path').'components/ourtvs/tv/input/tpl/templateselect.tpl';
        }
        public function process($value, array $params = array()) {
        }
    }
}
return 'TemplateSelectInputRender';

В 3.x класс называется MODX\Revolution\modTemplateVarInputRender. Глобальное имя работает, пока включены deprecated class aliases (так по умолчанию). Можно написать use MODX\Revolution\modTemplateVarInputRender; в начале файла, если хотите namespaced-класс.

Встроенные рендеры ввода лежат в core/src/Revolution/Processors/Element/TemplateVar/Renders/mgr/input/, их шаблоны — в manager/templates/default/element/tv/renders/input/. Копируйте listbox-single.tpl как образец: он оборачивает виджет в Ext.onReady и регистрирует поле в форме ресурса (Ext.getCmp('modx-panel-resource').getForm().add(fld)). Кастомные типы ищутся после встроенных, поэтому перекрыть встроенный тип они не могут.

getTemplate() указывает на Smarty-файл. Положите его сюда:

core/components/ourtvs/tv/input/tpl/templateselect.tpl

<select id="tv{$tv->id}" name="tv{$tv->id}" class="combobox"></select>
<script type="text/javascript">
// <![CDATA[
{literal}
Ext.onReady(function() {
    const fld = MODx.load({
{/literal}
        xtype: 'modx-combo-template'
        ,name: 'tv{$tv->id}'
        ,hiddenName: 'tv{$tv->id}'
        ,transform: 'tv{$tv->id}'
        ,id: 'tv{$tv->id}'
        ,width: 300
        ,value: '{$tv->value}'
{literal}
        ,listeners: { 'select': { fn:MODx.fireResourceFormChange, scope:this}}
    });
    Ext.getCmp('modx-panel-resource').getForm().add(fld);
});
{/literal}
// ]]>
</script>

Ext.onReady и getForm().add(fld) — то же делают встроенные рендеры: без регистрации поля в форме ресурса оно может отрисоваться, но не участвовать в проверке и отслеживании изменений формы.

ExtJS не обязателен. Подойдёт обычный HTML. У контрола должно быть имя tv{$tv->id}.

Создайте TV, в Input Type выберите templateselect, назначьте TV шаблону, откройте ресурс. Должен появиться список шаблонов:

Если снова текстовое поле: плагин включён на OnTVInputRenderList, путь к class-файлу совпадает с event->output, ключ типа templateselect.

Создайте контроллер вывода¶

Создайте файл:

core/components/ourtvs/tv/output/templateselect.class.php

<?php
if (!class_exists('TemplateSelectOutputRender')) {
    class TemplateSelectOutputRender extends modTemplateVarOutputRender {
        public function process($value, array $params = array()) {
            return '<div class="template">'.$value.'</div>';
        }
    }
}
return 'TemplateSelectOutputRender';

На фронтенде это выведет ID выбранного шаблона внутри div — но только если у TV выбран ваш тип вывода. Рендер вывода ищется по полю Output Type (display) TV; когда оно пустое, MODX печатает значение обычным text и вашего div не будет. Поэтому после создания контроллера вывода: откройте TV, в Output Type укажите templateselect, сохраните и проверьте фронтенд.

Другие события TV¶

Четыре события выше покрывают отрисовку. Редактор TV и процессоры также вызывают OnTVFormPrerender, OnTVFormRender, OnTVFormSave, OnTVFormDelete, OnTemplateVarBeforeSave, OnTemplateVarSave, OnTemplateVarBeforeRemove и OnTemplateVarRemove — используйте их, когда нужен хук на жизненный цикл TV, а не на отрисовку.

Смотрите также¶