Сниппет getResources

G
N
I
D
A
O
L

Статья

image news
view558

Сниппет getResources

В этой статье разберем: что такое MODx-чанки, для чего они используются, как их создать и, непосредственно, самостоятельно использовать в конкретном сайте. Начнем мы с определения.

Что такое getResourses

Возвращает список используемых ресурсов (общее), играет роль фрагмента обобщения.

Проще говоря - позволяющий извлекать и выводить содержание полей других ресурсов в любом месте и виде.

Как использовать

Сниппет getResources может быть вызван через тег:

[ [getResources] ]

До версии 1.6.1-pl вызовы без указанного свойства &tpl будут выводить массив каждого ресурса в результирующем наборе (списке) и его полей. Начиная с версии 1.6.1-pl поведение изменилось, и вам придется использовать "&debug=`1`" для получения полного ответа. Пример:

[ [getResources? &debug=`1`] ]
[ [getResources? &parents=`choose_an_id` &debug=`1`] ]

Параметры

tpl - имя чанка, который выступает как шаблон ресурсов. В случае если шаблон не найден, данные будут выводиться в виде массива.

tplOdd - имя чанка, который выступает как шаблон с нечетным индексом.

tplFirst - имя чанка, который выступает как шаблон для первого ресурса.

tplLast - имя чанка, который выступает как шаблон для заключительного ресурса.

tpl_N -имя чанка, который выступает как шаблон для N-ного ресурса.

tpl_nN - имя чанка, который выступает как шаблон для каждого N-ного ресурса.

tplPath - каталог для просмотра чанков на базе файлов с использованием @FILE (по умолчанию assets_path + "elements/chunks/").

tplWrapper - название чанка serving как обвёртка шаблона для вывода (не работает с toSeparatePlaceholders. Плейсхолдер, где элементы вставлены - [ [+output] ]).

wrapIfEmpty - если истинна, будет выводить обвёртку указанную в &tplWrapper даже если вывод пуст.

outputSeparator - доп строка для разделения каждого шаблона.

toPlaceholder - если установлен, присвоит результат в этот плейсхолдер вместо вывода напрямую.

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

Свойства

Parents - список ID родительских ресурсов, разделенные запятыми. Для исключения родительских ресурсов используется ID ресурса со знаком минус. (по умолчанию ID текущего ресурса).

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

Depth - целочисленное значение, которое указывает глубину поиска ресурсов от родительского элемента (по умолчанию 10).

tvFilters - может применяться для фильтрации ресурсов по конкретным значениям TV. (mytv==somevalue, othertv==othervalue).

Sortby - может применяться для сортировки ресурсов по конкретным полям. (&sortby=`{"publishedon":"ASC", "createdon":"DESC"}`, по умолчанию – createdon).

sortbyAlias - сортировка по алиасу.

sortbyTV - сортировка по TV параметру.

limit - лимит выводимых ресурсов. Используйте 0 для снятия ограничения (по умолчанию 5).