• Что такое getResources?
• Требования
• История
• Загрузка
• Использование
• Доступные параметры
  • Параметры шаблонизации
  • Параметры выборки
• Доступные плейсхолдеры
• Примеры
• Показ переменных шаблона (Template Variables) с getResources
• Использование getPage для постраничной навигации
• Поиск и устранение неисправностей

Что такое getResources?

Общая цель — вывод списков Ресурсов и обощающий сниппет.

Требования

• MODX Revolution 2.0.0-beta5 или новее
• PHP5 или новее

История

getResources был написан Джейсоном Ковардом (Jason Coward, aka opengeek) и выпущен 30 июня 2009.

Загрузка

Пакет можно загрузить из админки MODX Revolution через Управление пакетами или из репозитория дополнений MODX здесь

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

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

[[getResources]]

Вызовы без заданного параметра &tpl будет просто выводить массив в виде списка каждого конечного ресурса и его полей.

Доступные параметры

Параметры шаблонизации

Параметры выборки

mytv==somevalue||mytv==othervalue

mytv==somevalue,othertv==othervalue

mytv==foo||mytv==bar,bartv==3||bartv==1

mytv==%a%

mytv==a%

mytv==%a

&sortby=`RAND()`

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

&sortby=`FIELD(modResource.id, 4,7,2,5,1 )`

&sortby=`FIELD(modResource.id,[[*templateVariable]])`

Другие параметры

Доступные плейсхолдеры

Плейсхолдеры доступные в ваших чанках форматирования getResources в основном зависят от ресурсов, которые вы перечисляете.

См. Все теги на странице "Часто используемые теги шаблона" — это список свойств, доступных для всех ресурсов.

Если ваш ресурс имеет переменные шаблона, те в свою очередь будут иметь соответствующие плейсхолдеры (помните, что плейсхолдеры будут использовать префикс, заданный через параметр &tvPrefix)

Кроме того, существуют следующие плейсхолдеры:

[[+idx]]

Примеры

Вывод списка дочерних ресурсов текущего ресурса, используя чанк 'myRowTpl':

[[!getResources? &parents=`[[*id]]` &tpl=`myRowTpl`]]

Вывод всех дочерних ресурсов ресурса с ID '5', за исключением ресурса 10, используя чанк 'myRowTpl':

[[!getResources? &parents=`5` &resources=`-10` &tpl=`myRowTpl`]]

Вывод всех дочерних ресурсов ресурса с ID '5', за исключением текущего ресурса, используя чанк 'myRowTpl':

[[!getResources? &parents=`5` &resources=`-[[*id]]` &tpl=`myRowTpl`]]

Вывод всех дочерних ресурсов ресурса с ID '5' с сортировкой как в дереве ресурсов используя чанк 'myRowTpl':

[[!getResources? &parents=`5` &tpl=`myRowTpl` &sortby=`{"menuindex":"ASC"}`]]

Вывод только заданных ресурсов, используя чанк 'myRowTpl':

[[!getResources? &parents=`-1` &resources=`10,11,12` &tpl=`myRowTpl`]]

Вывод последних 5 опубликованных ресурсов, у которых родительский ресурс с ID '5', используя шаблон 'blogPost':

[[!getResources? &parents=`5` &limit=`5` &tpl=`blogPost` &includeContent=`1`]]

Вывод списка дочерних ресурсов текущего ресурса, основанного на шаблоне ресурсов:

[[!getResources? &parents=`[[*id]]` &where=`{"template:=":8}` &tpl=`myRowTpl`]]

Вывод списка дочерних ресурсов текущего ресурса, где ID шаблона ресурсов равен 1 или 2:

[[!getResources? &parents=`[[*id]]` &where=`{"template:=":1, "OR:template:=":2}` &tpl=`myRowTpl`]]

Вывод списка дочерних ресурсов текущего ресурса, где ID шаблона ресурсов равен 1, 2 или 3 (вы не можете использовать тот же ключ больше одного раза):

[[!getResources? &parents=`[[*id]]` &where=`{"template:IN":[ 1,2,3 ]}` &tpl=`myRowTpl`]]

Показ сообщения, когда ничего не найдено (эквивалент "empty" в Ditto):

[[!getResources:default=`No results found`? &parents=`[[*id]]` &tpl=`myRowTpl`]]

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

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

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

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

&tvPrefix=``

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

[[+tv.my_tv]]

Использование getPage для постраничной навигации

В сочетании с getPage getResources позволяет делать мощные и гибкие нумерации ваших страниц.

Примеры

Берет первые 10 ресурсов, отсортированные по дате публикации (publishedon), которые внутри ресурса с ID 17, не больше чем на 2 уровня в глубину, с шаблоном 'blogListPost', включая переменные шаблона (TV) и содержимое (content):

[[!getPage? 
&elementClass=`modSnippet` 
&element=`getResources` 

&parents=`17` 
&depth=`2` 
&limit=`10` 
&pageVarKey=`page` 

&includeTVs=`1` 
&includeContent=`1` 

&tpl=`blogListPost`]]

<div class="paging"> 
    <ul class="pageList"> 
        [[!+page.nav]] 
    </ul> 
</div> 

и чанк blogListPost:

 
<div class="blogPost"> 
    <div class="date">[[+publishedon:strtotime:date=`%b %d %Y`]]</div> 
    <h2><a href="[[~[[+id]]]]" title="[[+pagetitle]]">[[+pagetitle]]</a></h2> 

    <p class="author"><strong>Author:</strong> <span class="author">[[+createdby:userinfo=`username`]]</span></p> 
    <p class="summary">[[+introtext]]</p> 
    <p class="readmore"><a href="[[~[[+id]]]]"><span>Read more</span></a></p> 

    <div class="clear"></div> 
</div> 
<hr/> 

Вывод последних за месяц ресурсов

Допустим у вас есть сниппет, который преобразовывает необходимую дату во время Unix, с которым сравнивается значение поля publishedon:

<?php
    $ts = !empty($input) ? strtotime($input) : time();
    return (string) $ts;

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

&where=`{"publishedon:>":[[time? &input=`-1 month`]]}`

Поиск и устранение неисправностей

Ничего не происходит

Прежде чем биться головой о стену, убедитесь, что это дополнение установленно на вашем сайте.

Выводится массив атрибутов

Вы забыли указать параметр `&tpl`. Без &tpl сниппет будет пытаться определить ресурсы, но вы не сказали ему как их форматировать. Проверьте, указан ли параметр &tpl в вызове вашего сниппета, как тут:

[[!getResources? &parents=`5` &limit=`5` &tpl=`blogPost`]]

ИЛИ

Вы допустили ошибку в имени чанка. Возможно у вас и указан &tpl, но чанк действительно существует? Если вы указали имя чанка, который не существует, getResources не будет знать как форматировать ваши ресурсы.

ИЛИ

Даже если вы правильно задали параметр &tpl, возможно, вы случайно забыли амперсанд к одному из ваших других параметров. Например limit=`5` приведет вызов сниппета к фейлу и атрибуты будут выведены без форматирования. Правильный формат должен быть &limit=`5`.

Тот же самый ресурс выводится несколько раз (1.2.2 и предыдущие релизы)

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

Содержимого там нет

Вы извлекаете правильные ресурсы и вы видите какие-топравильно отформатированные результаты, но ваш плейсхолдер

[[+content]]

ничего не выводит. Что происходит? Вам нужно указать параметр &includeContent=`1` чтобы получить содержимое.

См. также

Если вам нужно получить одно поле из другого ресурса, попробуйте использовать getResourceField.