Фильтры и модификаторы

Входной фильтр

В настоящее время входной фильтр обрабатывает вызовы тегов при подготовке к выходному фильтру. Обычно он используется только внутри MODX.

Выходной фильтр

В Revolution фильтр вывода применяет один или несколько серий выходных модификаторов, которые ведут себя аналогично вызовам PHx в MODX Evolution — за исключением того, что они встроены в ядро. Синтаксис выглядит так:

[[element:modifier=`value`]]

Они также могут быть прикованы цепью (выполнено слева направо):

[[element:modifier:anothermodifier=`value`:andanothermodifier:yetanother=`value2`]]

Вы также можете использовать их для изменения вывода сниппеты. Обратите внимание, что модификатор идет после имени сниппета и перед знаком вопроса, например:

[[mySnippet:modifier=`value`? &mySnippetParam=`something`]]

Если у вас есть более длинный код :then=:else= оператор, и вы хотите сделать его более читабельным, поместив его в несколько строк, это должно быть сделано так:

[[+placeholder:is=`0`:then=`
 // code
`:else=`
 // code
`]]

Модификаторы вывода

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

Условные модификаторы вывода

Модификаторы вывода строки

Кэширование

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

[[+placeholder:default=`Значение по умолчанию!`]]

Это означает, что может иногда быть пустым, а иногда нет. Почему вы хотите, чтобы это кэшировалось? Это исключило бы точку модификатора вывода.

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

В общем правило is: Если вы установите плейсхолдер в некэшированном сниппете, плейсхолдер также необходимо будет кэшировать, если вы ожидаете, что содержимое плейсхолдера будет отличаться.

Использование модификатора вывода со свойствами тега

Если у вас есть свойства для тега, вы можете указать эти после модификатора:

[[!getResources:default=`Извините, ничего не соответствует вашему запросу.`?
    &tplFirst=`blogTpl`
    &parents=`2,3,4,8`
    &tvFilters=`blog_tags==%[[!tag:htmlent]]%`
    &includeTVs=`1`
]]

Создание пользовательского модификатора вывода

Также, Сниппеты могут быть использованы в качестве пользовательских модификаторов. Проще говоря Сниппеты имя вместо модификатора. Пример сниппет makeExciting, который добавляет переменное количество восклицательных знаков:

[[*pagetitle:makeExciting=`4`]]

Этот вызов переменной документа с модификатором вывода передаст эти свойства в сниппет:

Вот пример реализации для нашего сниппета makeExciting:

$defaultExcitementLevel = 1;
$result = $input;
if (isset($options)) {
    $numberOfExclamations = $options;
} else {
    $numberOfExclamations = $defaultExcitementLevel;
}
for ( $i = $numberOfExclamations; $i > 0; $i-- ) {
    $result = $result . '!';
}
return $result;

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

Исходное входное значение будет возвращено, если сниппет возвращает пустую строку.

Цепочка (несколько выходных фильтров)

Хорошим примером цепочки может быть форматирование строки даты в другой формат, например так:

[[+mydate:strtotime:date=`%Y-%m-%d`]]

Прямой доступ к таблице modx_user_attributes в базе данных с использованием модификаторов вывода вместо Сниппета может быть достигнуто просто с помощью модификатора userinfo. Выберите соответствующий столбец из таблицы и укажите его как свойство модификатора вывода, например так:

User Internal Key: [[!+modx.user.id:userinfo=`internalKey`]]
User name: [[!+modx.user.id:userinfo=`username`]]
Full Name: [[!+modx.user.id:userinfo=`fullname`]]
Role:  [[!+modx.user.id:userinfo=`role`]]
E-mail: [[!+modx.user.id:userinfo=`email`]]
Phone: [[!+modx.user.id:userinfo=`phone`]]
Mobile Phone: [[!+modx.user.id:userinfo=`mobilephone`]]
Fax: [[!+modx.user.id:userinfo=`fax`]]
Date of birth: [[!+modx.user.id:userinfo=`dob`:date=`%Y-%m-%d`]]
Gender: [[!+modx.user.id:userinfo=`gender`]]
Country: [[+modx.user.id:userinfo=`country`]]
State: [[+modx.user.id:userinfo=`state`]]
Zip Code: [[+modx.user.id:userinfo=`zip`]]
Photo: [[+modx.user.id:userinfo=`photo`]]
Comment: [[+modx.user.id:userinfo=`comment`]]
Password: [[+modx.user.id:userinfo=`password`]]
Cache Password: [[+modx.user.id:userinfo=`cachepwd`]]
Last Login: [[+modx.user.id:userinfo=`lastlogin`:date=`%Y-%m-%d`]]
The Login:[[+modx.user.id:userinfo=`thislogin`:date=`%Y-%m-%d`]]
Number of Logins: [[+modx.user.id:userinfo=`logincount`]]

[[!+modx.user.id]] по умолчанию используется текущий зарегистрированный идентификатор пользователя. Конечно, вы можете заменить это на [[*madeby]] или другое поле ресурса или плейсхолдеров, которые возвращают числовой идентификатор, представляющий пользователя.

Обратите внимание, что идентификатор пользователя и имя пользователя уже доступны по умолчанию в MODX, поэтому вам не нужно использовать модификатор userinfo:

[[!+modx.user.id]] - Выводит идентификатор пользователя
[[!+modx.user.username]] - Выводит имя пользователя

Скорее всего, вы захотите вызывать их без кэширования (см. Примечание о кэшировании выше), чтобы предотвратить неожиданные результаты.

Примеры пользовательских фильтров вывода

Пользовательские выходные фильтры — это сниппеты MODX, предназначенные для форматирования вывода плейсхолдера в слое представления (в шаблоне или в блоке). Если необработанный плейсхолдер, например [[*pagetitle]].

возвращает строку текста, вы можете изменить ее с помощью пользовательского фильтра вывода, например: [[*pagetitle:myOutputFilter]].

просто создав сниппет с именем myOutputFilter

В приведенном выше примере значение pagetitle будет изменено сниппетом с именем myOutputFilter

Создание пользовательского модификатора вывода

При написании вашего собственного Модификатора вывода ваш сниппет может принимать следующие входные данные:

$input; // значение, которое форматируется/фильтруется
$options; // необязательные значения, передаваемые через обратные кавычки

Пользовательский выходной фильтр просто Сниппет это предназначено для изменения контента. Проще говоря Сниппет вместо модификатора.

Синтаксис в том, что имя Сниппета идет после двоеточия. Пример сниппет с именем ‘makeDownloadLink’: [[+file:makeDownloadLink=`notitle`]].

Это передаст эти свойства во сниппет:

Наиболее важным (и, возможно, самым очевидным) из этих параметров является параметр $input. Ваш сниппет может сделать что-то простое, как это: return strtolower($input);.

Примеры

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

Для авторов документации: пожалуйста, добавьте примеры в алфавитном порядке.

alternateClass

alternateClass просто проверяет, можно ли разделить переданное целое число (например, заполнитель подсчета) на два. Если это возможно, он возвращает класс, который вы указали в качестве свойства выходного фильтра.

<?php
/*
* На основе phx:alternateClass от Smashingred 
* Обновлено для Revolution Марком Хамстрой.
 */
if ($input % 2) {
  return $options;
} else {
  return ''; // Здесь можно установить другой класс
}
?>

Используйте как это: [[+component.idx:alternateClass=`alt`]].

parseLinks

Выходной фильтр parseLinks находит ссылки и заменяет их html <a> атрибутом </a>

<?php
/*
 * На основе phx:parseLinks
 */
$t = $input;
$t = ereg_replace("[a-zA-Z]+://([.]?[a-zA-Z0-9_/-])*", "<a href=\"\\0\">\\0</a>", $t);
$t = ereg_replace("(^| |\n)(www([.]?[a-zA-Z0-9_/-])*)", "\\1<a href=\"http://\\2\">\\2</a>", $t);
return $t;

parseTags

Этот parseTags принимает входные данные в виде списка, разделенного запятыми, и делает все отдельные теги ссылкой на ресурс 9 с параметром запроса tag=tagname, добавленным к ссылке.

<?php
/*
 * На основе phx:parseLinks
 */
$t = $input;
$t = ereg_replace("[a-zA-Z]+://([.]?[a-zA-Z0-9_/-])*", "<a href=\"\\0\">\\0</a>", $t);
$t = ereg_replace("(^| |\n)(www([.]?[a-zA-Z0-9_/-])*)", "\\1<a href=\"http://\\2\">\\2</a>", $t);
return $t;

parseTags

Этот parseTags принимает входные данные в виде списка, разделенного запятыми, и делает все отдельные теги ссылкой на ресурс 9 с параметром запроса tag=tagname, добавленным к ссылке.

<?php
/*
 * parseTags output filter
 * by Mark Hamstra (http://www.markhamstra.nl)
 * free to use / modify / distribute to your will
 */
if ($input == '') { return ''; } // Output filters are also processed when the input is empty, so check for that.
  $tags = explode(', ',$input); // Based on a delimiter of comma-space.
  foreach ($tags as $key => $value) { // Process them individually
    $output[] = '<a href="'.$modx->makeurl(9, '', array('tag' => $value)).'">'.$value.'</a>';
  }
  return implode(', ',$output); // Delimit again with a comma-space

shorten

Это сокращает ввод, например :ellipsis, но не усекает слова. По умолчанию длина макс. 50 символов. Основано на коде от gOmp.

<?php
$output = '';
$options = !empty($options)?$options:50;
if (!empty($input) && !empty($options)) {
  if (strlen($input) > $options) {
    $output = substr($input, 0, strrpos(substr($input, 0, $options), ' ')).' …';
  }
  else{
    $output = $input;
  }
}
return $output;
?>

substring

Получить подстроку ввода.

<?php
$options=explode(',',$options);
return count($options)>1 ? substr($input,$options[0],$options[1]) : substr($input,$options[0]);
?>

Пример:

<span>[[*introtext:substring=`0,1`]]</span>[[*introtext:substring=`1`]]

numberformat

PHP: number_format

<?php
$number = floatval($input);
$optionsXpld = @explode('&', $options);
$optionsArray = array();
foreach ($optionsXpld as $xpld) {
    $params = @explode('=', $xpld);
    array_walk($params, function(&$v) { return $v = trim($v);});
    if (isset($params[1])) {
        $optionsArray[$params[0]] = $params[1];
    } else {
        $optionsArray[$params[0]] = '';
    }
}
$decimals = isset($optionsArray['decimals']) ? $optionsArray['decimals'] : null;
$dec_point = isset($optionsArray['dec_point']) ? $optionsArray['dec_point'] : null;
$thousands_sep = isset($optionsArray['thousands_sep']) ? $optionsArray['thousands_sep'] : null;
$output = number_format($number, $decimals, $dec_point, $thousands_sep);
return $output;

Пример:
[[+price:numberformat=`&decimals=2&dec_point=,&thousands_sep=.`]]