[pdoTools] Версия 2.1 - улучшения Fenom

Привет друзья! Хочу представить вам новую версию pdoTools с улучшениями работы шаблонизатора Fenom.

Функциональность vs Безопасность

Я долго думал, как бы разрешить менеджерам запускать чанки и сниппеты, но при этом не пускать их к объектам MODX. Потому что, если включить системную настройку pdotools_fenom_modx, то любой менеджер сможет сделать в чанке вот так:

{if $res = $modx->getObject('modResource', 1)}
	$res->remove();
{/if}

Нам бы этого не хотелось, правда?

С другой стороны, я не хочу придумывать очередной псевдоязык команд, типа

{runSnippet('name', [params => data])}

или

{'name' [params => data] | snippet}

Поэтому я добавил специальную переменную {$_modx}, которая ссылается на небольшой безопасный класс, где есть только нужные менеджерам функции и свойства:

• {$_modx->placeholders} — массив с системными плейсхолдерами
• {$_modx->config} — массив с системными настройками
• {$_modx->context} — массив (не объект!) с текущим контекстом
• {$_modx->user} — массив (не объект!) с текущим пользователем
• {$_modx->resource} — массив (не объект!) с текущим ресурсом
• {$_modx->lexicon} — служба загрузки лексиконов
• {$_modx->lexicon()} — функция для вывода строки из лексикона
• {$_modx->runSnippet()} — запуск сниппета
• {$_modx->runProcessor()} — запуск процессора
• {$_modx->getChunk()} — вывод чанка
• и т.д., смотрите исходник.

Немного примеров:

{$_modx->runSnippet('pdoMenu', [
    'parents' => 0,
    'level' => 2
])}

<p>
{$_modx->lexicon->load('ms2gallery:default')}
Проверка словарей ms2Gallery: {$_modx->lexicon('ms2gallery_err_gallery_exists')}
</p>

<p>
{if $_modx->isAuthenticated('web')}
    Привет, {$_modx->user.fullname}!
{else}
    Вам нужно авторизоваться =(
{/if}
</p>

<p>Текущий контекст: {$_modx->context.key}</p>

Таким образом, теперь можно использовать основные функции MODX из Fenom безопасно, не давая доступ к ядру сайта менеджерам и не рискуя удалением объектов из чанков.

В отличии от {$modx}, {$_modx} доступен всегда, во все чанках и не зависит от системных настроек. Он просто добавяляет нужные фукнции от MODX шаблонизатору, чтобы можно было выводить данные текущего юзера или ресурса.

Есть еще одна подобная служебная переменная (просто напоминаю) — {$_pls}, в ней вы можете найти все значения, переданные в чанк сниппетом.

Расширение шаблонов

Второе большое изменение — внедрение собственного провайдера шаблонов в Fenom, чтобы он научился самостоятельно загружать и использовать чанки MODX.

Теперь вы можете делать в своих чанках и шаблонах вот так:

{include 'имя чанка'}
или
{include 'template:имя шаблона'}

Подробнее про include в документации автора, но лично мне было интереснее, чтобы заработал extends.

Включаем системную настройку pdotools_fenom_parser и пишем новый шаблон Fenom Base:

<!DOCTYPE html>
<html lang="en">
<head>
	{include 'head'}
</head>
<body>
	{block 'navbar'}
		{include 'navbar'}
	{/block}
	<div class="container">
		<div class="row">
			<div class="col-md-10">
				{block 'content'}
				    {$_modx->resource.content}
				{/block}
			</div>
			<div class="col-md-2">
				{block 'sidebar'}
					Sidebar
				{/block}
			</div>
		</div>
		{block 'footer'}
        		{include 'footer'}
		{/block}
	</div>
</body>
</html>

Как видите, он включает обычные чанки (в которых, кстати, обычные плейсхолдеры MODX от Theme.Bootstrap) и определяет несколько блоков (block), которые можно расширить в другом шаблоне!

Пишем второй шаблон Fenom Extended:

{extends 'template:Fenom Base'}

{block 'content'}
    <h3>{$_modx->resource.pagetitle}</h3>
    <div class="jumbotron">
	    {parent}
    </div>
{/block}

Здесь происходит расширение базового шаблона — меняется блок с контентом страницы.

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

• 
• 

Теперь вы можете написать один базовый шаблон и расширить его дочерними. Точно также можно писать и расширять чанки, только обратите внимание, что для работы с modTemplate нужно указывать префикс template:, а для чанков нет — они работают по умолчанию во всех include и extends.

Более подробно работу с Fenom я освещал на последнем платном курсе занятий, так что повторяться не буду.

Заключение

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

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

Обновляемся, тестируем, пишем о багах. Не забудьте обновить и редактор Ace, чтобы появилась подсветка синтаксиса Fenom!

Обновление от 12.08.2015

С версии 2.1.1-pl, все обычные вызовы сниппетов становятся кэшированными:

{$_modx->runSnippet('pdoResources')}

Некэшированный вызов, понятно дело, вот такой:

{$_modx->runSnippet('!pdoResources')}

Также добавил поддержку наборов параметров:

{$_modx->getChunk('Name@PropertySet')}
{$_modx->runSnippet('NameName@PropertySet')}

{include 'Name@PropertySet'}
{include 'template:TemplateName@PropertySet'}

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

И pdoParser, наконец-то, больше не считается экспериментальным и включен по умолчанию.

{$modx->getChunk('header')}

{$modx->resource->pagetitle}

{$_modx->resource->pagetitle}

[2015-08-09 21:49:57] (ERROR @ /index.php) Unexpected token ':' in dbccdb164f95db466d6a1767b77d8439 line 100, near '{"published":' <- there
[2015-08-09 21:49:57] (ERROR @ /index.php) Unexpected tag 'id' in eb0d35336142950cde89e17358f5feb1 line 492, near '{id:' <- there
[2015-08-09 21:49:57] (ERROR @ /index.php) Unexpected tag 'id' in eb0d35336142950cde89e17358f5feb1 line 492, near '{id:' <- there

[[pdoResources?
            &parents=`19`
            &depth=`0`
            &tpl=`slider.row`
            &where=`{"isfolder":1}`

            ]]

[2015-08-31 15:23:10] (ERROR @ /index.php) Unexpected tag 'id' in 079514a82982ed70e4d46eeed06b9ffc line 542, near '{id:' <- there

{$_modx->runSnippet('pdoResources', array(
        'parents' => 2,
        'prepareTVs' => 1,
        'includeTVs' => 'price,image,new',
        'limit' => 10,
        'tpl' => 'productTpl',
        'showLog' => true,
        'where' => json_encode(
                            array("template" => 3, 
                                "new" => 1
                                    )
                                )
       ))}

{$_modx->runSnippet('!HybridAuth', [
'providers' => 'Yandex',
'logoutTpl' => '@FILE hybridauth/tpl.HybridAuth.logout.tpl'
]
)}

{$_modx->getChunk('demo.propert')}

{$_modx->runSnippet('AjaxSnippet@PropertySet', ['snippet' => 'msProducts',  'element' => 'pdoResources', 'parents' => 0, 'limit' => 1, 'as_target' => '#propert', 'as_mode' => 'onload', 'wrapper' => 'ajax_obert', 'tpl' => 'demo.propert',])}

<dd><a href="{$_modx->makeUrl($_pls['vendor.resource'])}">текст</a> ({$_pls['vendor.name']})</dd>

{$_modx->getPlaceholder('vendor.name')}

{$_modx->resource.id}
{$_modx->makeUrl(15)}
{$_modx->config.site_name}
{if true}
    <p>Привет</p>
{else}
    <p>Пока</p>
{/if}

parser_class-pdoParser
parser_class_path-{core_path}components/pdotools/model/pdotools/
pdotools_fenom_cache-Нет
pdotools_fenom_default-Да
pdotools_fenom_modx-Да
pdotools_fenom_parser-Да
pdotools_fenom_php-Нет

$doc = $modx->resource;
$desc = (int) $doc->get('description');
$doc->set('description',++$desc);
$doc->save();

<link rel="prev" href="news/page/3"/>
<link rel="next" href="news/page/5"/>
<link rel="prev" href="news/page/4?page=3"/>
<link rel="next" href="news/page/4?page=5"/>

<link rel="prev" href="news/page/4?page=3"/>
<link rel="next" href="news/page/4?page=5"/>