MODx Revo сниппет getResources: параметры, плейсхолдеры, применение.
Сниппет «getResources», как вы могли уже догадаться по его названию, используется для получения списка ресурсов. Если вы читали урок, посвященный реализации новостной ленты с помощью сниппета «Ditto» для MODx Evo, то вы наверняка поняли, что «getResource» это его альтернативное решение.
Параметры сниппета getResource.
Их условно можно разделить на параметры:
- шаблонизации – отвечают за шаблон вывода ресурсов;
- выбора – отвечают за условия выбора списка ресурсов;
- служебные – дополнительные (вспомогательные);
Параметры шаблонизации.
- &tpl=`` - задает имя чанка, в котором содержится шаблон вывода единичного ресурса. Если шаблон не задан, то по умолчанию выводится в виде обычного ненумерованного списка.
- &tplOdd=`` - задает имя чанка, в котором содержится шаблон вывода ресурсов с нечетным индексом;
- &tplFirst=`` - задает имя чанка, в котором содержится шаблон вывода первого ресурса;
- &tplLast=`` - задает имя чанка, в котором содержится шаблон вывода последнего ресурса;
- &tpl_#=`` задает имя чанка, в котором содержится шаблон вывода #-го ресурса;
- &tpl_n#=`` - задает имя чанка, в котором содержится шаблон вывода ресурсов кратным #;
- &outputSeparator=`` - задает разделитель между ресурсами;
- &toPlaceholder=`` - задает вывод результата в плейсхолдер.
Параметры выбора.
- &parents=`` - задает список идентификаторов родительских ресурсов, из которых осуществляется выборка. Если необходимо исключить родительский ресурс, перед его идентификатором необходимо поставить знак «-»;
- &resources=`` задает список идентификаторов ресурсов, которые нужно принудительно включить в результаты выборки. Если нужно исключить ресурсы из результатов, то перед идентификатором нужно указать знак «-»;
- &depth=`` - задает глубину выборки от ресурса родителя;
- &tvFilters=`` - задает отбор ресурсов по TV параметрам;
- &sortby=`` - задает поле для сортировки;
- &sortdir=`` - задает порядок сортировки;
- &sortbyTV=`` - задает TV параметр, по которому будет происходить сортировка;
- &sortdirTV=`` - задает порядок сортировки по TV- параметру;
- &sortbyTvType=`` - задает тип TV-параметра сортировки;
- &limit=`` - задает количество выводимых ресурсов;
- &where=`` - задает дополнительные условия отбора.
Вспомогательные параметры.
- &showUnpublished=`` - если выставлен в 1, то будет показывать в выборке неопубликованные ресурсы;
- &showDeleted=`` - если выставлен в 1, то будет показывать в выборке удаленные ресурсы;
- &showHidden=`` - если выставлен в 1, то будет показывать в выборке ресурсы, для которых выставлено свойство не показывать в меню;
- &hideContainers=`` если указан, то из выборки будут исключены ресурсы – контейнеры;
- &includeContent=`` - если указан, то в результатах будет содержаться содержимое ресурсов;
- &includeTVs=`` - если указан, то в результатах будет содержаться значения TV-параметров ресурсов;
- &includeTVList=`` - задает список TV-параметров ресурсов, значения которых должны содержаться в результатах выборки;
- &tvPrefix=`` - задает префикс для TV-параметров в результате выборки, по умолчанию используется «tv».
- &debug=`` - включает или выключает режим правки.
Плейсхолдеры сниппета getResources.
В качестве плейсхолдеров сниппета доступны все теги выбираемых ресурсов, а также указанные для выборки TV-параметры.
Примеры использования сниппета getResources.
Вывод списка дочерних ресурсов для текущего ресурса с использование шаблона в чанке tplRes:
[ [getResources? &parents=`` &tpl=`tplRes`]]
Вывод всех дочерних ресурсов родителя с идентификатором 3, за исключением текущего ресурса, с сортировкой по заголовку ресурса в обратном порядке.
[ [getResources? &parents=`3` &resources=`-` &sortby=`pagetitle` &sortdir=`DESC`]]
или
[ [getResources? &parents=`3` &resources=`-` &sortby=`{“pagetitle”:”DESC”}`]]
Если вам нужны будут конкретные примеры использования сниппета с различными параметрами или у вас возникли с ним трудности пишите в комментарии, я постараюсь ответить.
А в дальнейшем я расскажу вам о еще одном сниппете «getPage» и совместном его использование с getResources для реализации новостной ленты или списка статей с постраничной паджинацией.
Будь в курсе!
Введите Ваш Email и имя.
Чтобы отписаться нажмите сюда ».