Сниппет getResources

Опубликовано: 02 Мая 2014

GetResources - выводит информацию из ресурсов по заданному шаблону.

Параметр

Описание

По умолчанию

Пример

&tpl

Имя чанка, выступающего в качестве шаблона для ресурса.

Cвойства выдаются в виде списка для каждого ресурса

&tpl=`news `

&tplOdd

Имя чанка, выступающего в качестве шаблона для ресурсов с нечетным индексом

(см. параметр idx)

нет

&tplOdd=`news_odd `

&tplFirst

Имя чанка, выступающего в качестве шаблона для первого ресурса

нет

&tplFirst=`news_first `

&tplLast

Имя чанка, выступающего в качестве шаблона для последнего ресурса

нет

&tplLast=` news_last`

&tpl_N

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

нет

&tpl_4=`tpl4th`

&tpl_nN

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

нет

&tpl_n4=`tpl4th` будет применен к каждому элементу, порядковый номер которого кратен 4

&tplPath

Дополнительный каталог для поиска чанков на основе файлов при использовании биндинга @FILE

assets_path + "elements/chunks/"

&tplPath= `assets_path + "name" `

&outputSeparator

Дополнительные строки для разделения каждого ресурса после шаблонизации

"\n"

&outputSeparator=`</br>`

&toPlaceholder

Если установлен, присвоит результат в указанный плейсхолдер вместо вывода напрямую

нет

&toPlaceholder=`name_placeholder`

&toSeparatePlaceholders

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

нет

&toSeparatePlaceholders=`name`

В результате мы получим на странице возможные плейсхолдеры , и т.д.

&parents

Список идентификаторов родительских ресурсов, разделенных запятыми. Используйте -1 для исключения родительских ресурсов.

current Resource id

&parents=`6`

&resources

Список идентификаторов родительских ресурсов, разделенных запятыми. Используйте -1 для исключения родительских ресурсов.

current Resource id

&resources=`8`

&depth

Целое число, указывающее глубину поиска для ресурсов от каждого из родителей.

10

&depth=`4`

&tvFilters

Может использоваться для фильтрации ресурсов по определенным значениям переменных шаблона (TV). Они задаются как [(tvname) (operator)](value). Можно использовать два разделителя для объединения условий фильтра.

 

нет

&tvFilters=`myTv<>5`

 

&sortby

Любое поле ресурса (за исключением переменных шаблона) для сортировки.

publishedon

&sortby=`{"publishedon":"ASC","createdon":"DESC"}`

&sortbyAlias

Псевдоним запроса для поля из sortby

нет

&sortByAlias=`Profile`

&sortbyEscaped

Экранировать имя поля заданного в sortby

нет

&sortbyEscaped=``

&sortdir

Порядок сортировки

DESC

&sortdir=`ASC`

&sortbyTV

Переменная шаблона (Template Variable) для сортировки

нет

&sortbyTV=`tv_name`

&sortdirTV

Порядок сортировки при использовании sortbyTV

DESC

&sortdirTV=`ASC`

&sortbyTVType

Указывает тип данных сортировки по TV. Возможные значения: string, integer, decimal, datetime

string

&sortbyTVType=` decimal `

&limit

Ограничение количества возвращаемых ресурсов

5

&limit=`10`

&offset

Смещение ресурсов для пропуска, которые возвращаются в соответствии с критериями

0

&offset=`2`

&where

Выражение критериев в json-стиле для построения любых дополнительных условий

нет

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

&context

В каком контексте следует искать.

Текущий контекст.

&context=`new_context`

&showUnpublished

Если true, то будут показаны также ресурсы, которые не опубликованы

0

&showUnpublished=`1`

&showDeleted

Если true, то будут показаны ресурсы независимо от того, удалены они или нет.

0

&showDeleted=`1`

&showHidden

Если true, покажет ресурсы независимо от того, показываются они в меню или нет.

0

&showHidden=`1`

&hideContainers

Если указан, то не будут показаны ресурсы, помеченные как контейнер (is_folder).

0

&hideContainers=`1`

&includeContent

Указывает, что содержание каждого ресурса должно возвращаться в результатах выборки

0

&includeContent=`1`

&includeTVs

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

0

&includeTVs =`1`

&includeTVList

Дополнительный список разделенных запятыми имеет переменных шаблона для явного включения в результат, если includeTVs установлен в 1

0

&includeTVList=`tv, new_tv`

&processTVs

Указывает, что переменные шаблона должны быть отрисованы так как они были бы представлены в ресурсе. Переменные шаблона должны быть включены для обработки (см. includeTVs/includeTVList)

0

&processTVs=`1`

&processTVList

Дополнительный список имен переменных шаблона, разделенных запятыми, для явной обработки. Переменные шаблона, заданные здесь, должны быть включены через includeTVs/includeTVList

0

&processTVList=`tv, new_tv`

&tvPrefix

Префикс для свойств в виде переменных шаблона

tv

&tvPrefix=`other`

&idx

Вы можете задать начало idx ресурсов, что представляет собой свойство, котороые увеличивается с каждым отрисованным ресурсом

1

&idx=`5`

&first

Задает idx, который представляет собой первый ресурс

1

&first=`7`

&last

Задает idx, который представляет последний ресурс.

Количество ресурсов, которые будут складываться + первый - 1

&last=`57`

&totalVar

Задает ключ плейсхолдера, устанавливаемого getResources для показа общего количества ресурсов, которые будут выбраны не учитывая значения limit.

total

&totalVar =`new.total`

&debug

Если true, будет записывать sql-запросы в log MODX.

false

&debug=`1`

 

Использование

[ [!getResources? &parents=`7` &tpl=`myChunkTpl`] ]

Показ переменных шаблона (Template Variables) с getResources

Чтобы уменьшить время обработки, getResources не получает значения TV по умолчанию. Если вы хотите показывать TV, вы должны включить следующие параметры:

&includeTVs=`1` &processTVs=`1`

Вам также нужен либо префикс для всех TV с tv. или использовать этот параметр в теге вашего сниппета:

&tvPrefix=``

В чанке tpl, который вы используете для вывода getResources, используйте тег плейсхолдера как здесь (но с именем вашего TV):

Комментарии (0)


Оставить комментарий




Разрешённые теги: <b><i><br>Добавить новый комментарий: