[pdoTools] 2.0.0-beta c шаблонизатором Fenom

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

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

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

Возможности

• Включение поддержки Fenom раздельно для каждого сниппета pdoTools.
• Можно использовать плейсхолдеры MODX и теги Fenom одновременно. Но быстрее будет использовать что-то одно.
• Если в чанке нет плейсхолдеров MODX, то парсер MODX не запускается
• Если в чанке нет тегов Fenom, то он тоже не запускается.
• @INLINE чанки работают

В отличии от других решений, вам не нужно никаким образом менять или переписывать свои сниппеты — всё крутится через методы pdoTools::getChunk() и pdoTools::parseChunk() автоматически.

Особенности

Для включения шаблонизатора в вызове любого сниппета pdoTools нужно указать

&useFenom=`1`

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

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

Адрес сайта: {$modx->config.site_url}

{if $modx->user->isAuthenticated($modx->context->key)}
	Юзер авторизован в контексте
{else}
	Это гость
{/if}

Шаблоны компилируюся и сохраняются в директорию /cache/fenom/. При очистке кэша сайта они удаляются.

Строковые плейсхолдеры [[+section.pagetitle]] превращаются в {$section_pagetitle}, так как Fenom ожидает через точку ключ массива. То есть {$section.pagetitle} — это для него $section['pagetitle'].

Тестирование

Лично я уже переписал основные чанки modx.pro на синтаксис Fenom — багов пока не замечено. Даже на моих старых полностью оптимизированных чанках, максимально разогнанных в pdoTools, я заметил прирост от 20% до 50% при более удобном синтаксисе.

Например, наша самая большая тема с 437 комментариями раньше открывалась за 1.3-1.5 сек, теперь за 0.7-0.9 сек.

Синтетический тест из этой темы показывает небольшой перевес чистого pdoTools над Fenom, если в чанке нет ни одного фильтра вывода (то есть, работает только str_replace(), без парсера MODX).

pdoTools

0.0005119: Created inline chunk
0.1967380: Total time
3 670 016: Memory usage

Fenom

0.0004470: Created inline chunk
0.2136431: Total time
3 407 872: Memory usage

А вот если добавить всего один плейсхолдер, который должен быть разобран парсером MODX

// pdoTools
$tpl1 = '@INLINE <p>[[++site_name]] [[+val1]] - [[+val2]] - [[+val3]]</p>';
// Fenom
$tpl2 = '@INLINE <p>{$modx->config.site_name} {$val1} - {$val2} - {$val3}</p>';

То результат будет совсем иной:
pdoTools

0.0003500: Created inline chunk
1.8580759: Total time
3 670 016: Memory usage

Fenom

0.0004060: Created inline chunk
0.2227199: Total time
3 932 160: Memory usage

Да-да, это не ошибка!

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

Скомпилированный шаблон выглядит вот так:

<?php 
/** Fenom template 'cd20f5e1f2f6add74ba06c086f8b8242.fenom.tpl' compiled at 2015-05-18 21:44:23 */
return new Fenom\Render($fenom, function ($var, $tpl) {
?><p><?php
/* cd20f5e1f2f6add74ba06c086f8b8242.fenom.tpl:1: {$modx->config.site_name} */
 echo $var["modx"]->config["site_name"]; ?> <?php
/* cd20f5e1f2f6add74ba06c086f8b8242.fenom.tpl:1: {$val1} */
 echo $var["val1"]; ?> - <?php
/* cd20f5e1f2f6add74ba06c086f8b8242.fenom.tpl:1: {$val2} */
 echo $var["val2"]; ?> - <?php
/* cd20f5e1f2f6add74ba06c086f8b8242.fenom.tpl:1: {$val3} */
 echo $var["val3"]; ?></p><?php
}, array(
	'options' => 0,
	'provider' => false,
	'name' => 'cd20f5e1f2f6add74ba06c086f8b8242.fenom.tpl',
	'base_name' => 'cd20f5e1f2f6add74ba06c086f8b8242.fenom.tpl',
	'time' => 1431974663,
	'depends' => array (
  0 => 
  array (
    'cd20f5e1f2f6add74ba06c086f8b8242.fenom.tpl' => 1431974663,
  ),
),
	'macros' => array(),

        ));

Ну и напоследок несколько примеров для гладкого переезда.

Примеры

Замена плейсхолдеров:

[[+pagetitle]]	- {$pagetitle}
[[*pagetitle]]	- {$modx->resource->pagetitle}
[[%lexicon]]	- {$modx->lexicon('lexicon')}
[[~[[+id]]]]	- {$modx->makeUrl($id)}

Вот какой был старый чанк tpl.Tickets.comment.wrapper блока комментариев.
А вот как я переписал его на Fenom:

<div class="comments">
	{if $modx->user->isAuthenticated($modx->context->key)}
	<span class="comments-subscribe pull-right">
		<label for="comments-subscribe" class="checkbox">
			<input type="checkbox" name="" id="comments-subscribe" value="1" {$subscribed != '' ? 'checked' : ''} /> {$modx->lexicon('ticket_comment_notify')}
		</label>
	</span>
	{/if}
 
	<h4 class="title">{$modx->lexicon('comments')} (<span id="comment-total">{$total}</span>)</h4>
 
	<div id="comments-wrapper">
		<ol class="comment-list" id="comments">{$comments}</ol>
	</div>
 
	<div id="comments-tpanel">
		<div id="tpanel-refresh"></div>
		<div id="tpanel-new"></div>
	</div>
</div>

Еще пример старого чанка tpl.Tickets.comment.list.row.
И новая Fenom-версия:

<div class="ticket-comment-row ticket-comment" id="comment-{$id}" data-id="{$id}">
	<div class="ticket-comment-body {$guest ? 'ticket-comment-guest' : ''}">
		<div class="ticket-comment-header">
			<div class="user-avatar-wrapper">
				<img src="{$avatar}" class="ticket-avatar" alt="" />
			</div>
			<span class="ticket-comment-author">{$fullname}</span>
			<span class="ticket-comment-createdon">{$date_ago}</span>
			<span class="ticket-comment-link"><a href="{$url}#comment-{$id}">#</a></span>
			<span class="ticket-comment-star {$can_star ? 'active' : ''}">
				<i class="glyphicon glyphicon-star {$stared ? 'stared' : 'unstared'} star"></i>
			</span>

			<span class="ticket-comment-rating {$can_vote ? 'active' : 'inactive'}">
				<span class="rating {$rating_positive ? 'positive' : ''}{$rating_negative ? 'negative' : ''}" title="Всего: {$rating_total}: ↑{$rating_plus} и ↓{$rating_minus}">{$rating}</span>
				<span class="vote plus {$voted_plus ? 'voted' : ''}" title="Нравится"><i class="glyphicon glyphicon-arrow-up"></i></span>
				<span class="vote minus {$voted_minus ? 'voted' : ''}" title="Не нравится"><i class="glyphicon glyphicon-arrow-down"></i></span>
			</span>
		</div>
		<div class="ticket-comment-text">
			{$text}
		</div>
	</div>

	<div class="ticket-comment-meta">
		<a href="{$modx->makeUrl($section_id)}" class="ticket-comment-section"><i class="glyphicon glyphicon-folder-open"></i> {$section_pagetitle}</a> →
		<a href="{$modx->makeUrl($ticket_id)}" class="ticket-comment-ticket">{$ticket_pagetitle}</a>  
		<span class="ticket-comment-comments">
			<small><i class="glyphicon glyphicon-comment"></i> {$comments}</small>
		</span>
	</div>
</div>

Обратите внимание на свободный вызов {$modx->makeUrl()} и другие интересные конструкции.

А вот вообще отмороженный пример:

[[!pdoResources?
	&useFenom=`1`
	&parents=`999999`
	&wrapIfEmpty=`1`
	&tplWrapper=`@INLINE 
		{set $collection = $pdoTools->getCollection('modResource', null, ['parents' => 0, 'limit' => 10])}
		{foreach $collection as $idx => $res}
			<p>{$res.id} - {$res.pagetitle}</p>
			{$pdoTools->addTime('Строка ' ~ $idx)}
		{/foreach}
		<pre>{$pdoTools->getTime()}</pre>
	`
]]

Вызов метода pdoTools с присвоением его результата переменной и разбор её в цикле.

pdoResources тут нужен только для запуска шаблона с Fenom.

Заключение

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

Технически в pdoTools изменений немного, но по факту — это огромный тектонический сдвиг в разработке сайтов с использованием библиотеки. Поэтому версия теперь 2.0.0-beta.

Наверное, будут вопросы, а почему именно Fenom, а не Twig, Smarty или кто-то еще? Вот мой список причин:

• Использование токенайзера вместо регулярок — выше скорость и ниже расход ОЗУ
• Автор — русскоговорящий и пишет документацию на родном языке
• Приятный php-подобный синтаксис, особенно что касается работы с массивами и объектами.
• Приятный исходный код.
• Судя по активности на GitHub, впереди у проекта светлое будущее
• Ну и наконец, я уже использовал его для работы на одном крупном кинопортале и остался доволен.

Обновляемся, тестируем, пишем отзывы.

Обновлено 20.05.2015

Выложил в репозиторий версию 2.0.0-rc, в которой pdoParser уже использует Fenom. Теперь новый синтакис можно использовать прямо в контенте документов и шаблонах.

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

Обновлено 21.05.2015

Итак, после долгих размышлений и тестов я переписал работу с Fenom так, чтобы скомпилированные шаблоны кэшировались только в ОЗУ.

Выходит, что в случае MODX, где данных хранятся в сравнительно небольших чанках, время на компиляцию шаблонов нивелируется постоянными обращениями к жесткому диску. В тестовых условиях отказ от кэширования файлов на HDD только увеличил скорость.

Чанки MODX не пишутся на диск, а Fenom не кэширует компилированные шаблоны рядом. Никакого мусора, всё быстро и красиво. Теперь Fenom показывает небольшой отрыв даже на простейших чанках без фильтров.

Ошибки компиляции, как и прежде, пишутся в журнал MODX. Так как исходники вам теперь посмотреть негде, на уровне INFO в лог отправляется и сам шаблон. Просто переключите системную настройку MODX log_level, чтобы это увидеть.

Так как Fenom предъявляет требования к именам переменных такие же, как и PHP, наши привычные плейхолдеры просто ломают компиляцию. Поэтому в новой версии все переданные плейсхолдеры можно найти в {$_pls}.
Например, плейсхолдеры превьюшек галереи получаем вот так:

[[!ms2GalleryResources?
	&typeOfJoin=`inner`
	&parents=`0`
	&tpl=`@INLINE
		<p><a href="{$uri}"><img src="{$_pls['120x90']}" /></a> {$rank}</p>
	`
]]

Точно так же получаем и плейсхолдеры с точкой:

{$_pls['section.uri']}

Больше никакой замены точек на подчеркивание в именах переменных — всё ради повышенной скорости работы.

Свежепоявившийся плагин pdoTools можно удалить. Он был нужен исключительно для очистки директории с кэшем, которой теперь нет.

Новая версия pdoTools 2.0.0-rc2 уже доступна в репозитории, обновляйтесь!

Анонс стабильной версии с множеством дополнительных настроек.

[[+price:default=`ноль`:eq=`5`:then=`пять`]]

{$id} - {$menutitle != '' ? $menutitle : $pagetitle}

{$modx->runSnippet('TicketMeta', array('id' => $id, 'tpl' => 'Project.row.Star', 'getSection'=>0, 'getUser'=>0, 'getFiles'=>0, 'unusedFiles'=>0))}

[2015-05-20 11:47:30] (ERROR @ /index.php) Unexpected token '150' in expression, expect '.' in 813a86bbda364c6febcdcf125bfe082d.fenom.tpl line 7, near '{$150' <- there

{if $modx->resource->id != $modx->getOption('site_start')}
    [[$asideLeft]]
{/if}

{if $modx->resource->id != $modx->getOption('site_start')}
    {$pdoTools->getChunk('asideLeft')}
{/if}

[[%lexicon_name? &namespace=`sitetranslations`]]

{$modx->lexicon('lexicon_name', ['namespace' => 'sitetranslations'])}
{$modx->lexicon('lexicon_name',  'sitetranslations')}
{$modx->lexicon('lexicon_name')}

[[%lexicon_name? &namespace=`sitetranslations`]]

{$modx->lexicon('lexicon_name_to')}

$tpl1 = '@INLINE <p><a href="[[~[[+id]]">[[+pagetitle]]</a></p>'

`[[+id]]` is not a valid integer and may not be passed to makeUrl()

[[$input?
               $input_error=`test`
            ]]

[[+input_error]]

[[!+fi.error.email]]

{use 'header'}

[[+pagetitle]]

{$pagetitle}

{$pagetitle}

[[+content:ellipsis=`200`]]

[[!+my.results]]

{$_pls['my.results']}

&where=`{"template":5}`

{var_dump($.get.city)}
{empty($.get.city)}

<!--tickets_captcha
<div class="form-group">
    <label for="comment-captcha" id="comment-captcha">[[+captcha]]</label>
    <input type="text" name="captcha" value="" id="comment-captcha" class="wpcf7-text" />
    <span class="error"></span>
</div>
-->

/components/pdotools/model/pdotools/pdotools.class.php : 977) Unexpected token ':' in ccfaa33771ae7e2120f1884ddb5abfce line 144, near '{"resource_id":' <- there
(ERROR @ /home//www/core/components/pdotools/model/pdotools/pdotools.class.php : 977) Unexpected tag 'mode' in b311a938ae7b6fb41a4bd04f6cb860ec line 523, near '{mode:' <- there
[2018-03-20 18:05:34] (ERROR @ /home//www/core/components/pdotools/model/pdotools/pdotools.class.php : 977) Unexpected tag 'mode' in 1207e2b16c0c303c4e34dda876b75a7b line 523, near '{mode:' <- there
[2018-03-20 18:05:36] (ERROR @ /home//www/core/components/pdotools/model/pdotools/pdotools.class.php : 977) Unexpected tag 'mode' in 73f419f93d3ec2357c622826f5e167e9 line 523, near '{mode:' <- there