Логотип

Документация по макросам и шаблонам UMI.CMS

content getList()

Название

%content getList()% — Выводит список элементов типа "Страница контента".

Параметры: content getList( [template = 'default', path = 0, maxDepth = 1, perPage = 0, ignorePaging = 0, sortField = '', sortDirection = 'asc'])

template

Шаблон, по которому выводится список элементов. В XSLT-шаблонизаторе игнорируется, можно указать любое значение.

path

ID или путь до раздела.

maxDepth

Максимальная глубина вложенности иерархии поиска элементов (во вложенных подстраницах).

perPage

Количество элементов, выводимых на странице (при постраничной навигации).

ignorePaging

Игнорировать постраничную навигацию.

sortField

Имя (идентификатор) поля, по которому должна выполняться сортировка. По умолчанию сортировка выполняется по расположению объектов в иерархии.

sortDirection

Порядок (направление) сортировки. Значение "asc" задает прямой порядок сортировки, "desc" — обратный.

Примечание: Сортировка по порядку действует только в пределах одного уровня вложенности.

Описание

Макрос выводит страницы контента из указанного раздела (может быть страницей любого типа). Если значение для параметра path не указано, то будут выведены корневые страницы контента. Если не указано значение для параметра perPage, то значение количества элементов на странице будет взято из настроек модуля "Структура".

$objects = $this->macros('content', 'getList', array(null, $page->getId(), 2, 10));

Пример вызова

udata://content/getList/notemplate/0/1/10/

XML-ответ UData

 

<udata xmlns:xlink="http://www.w3.org/TR/xlink" module="content" method="getList" generation-time="0.043208">
  <items>
    <item id="3" link="/" xlink:href="upage://3">
      <name>Лучшие предложения</name>
    </item>
<item id="6" link="/delivery_and_payment/" xlink:href="upage://6">
<name>Доставка и оплата</name>
</item>
<item id="7" link="/help/" xlink:href="upage://7">
<name>Помощь</name>
</item> </items> <total>3</total> <per_page>10</per_page> <parent_id>0</parent_id> </udata>

Элементы и атрибуты

<items>

Ветвь, содержащая элементы item — страницы контента.

<item>

Элемент, описывающий страницу контента. Содержимое элемента — название страницы.

@id

Идентификатор страницы.

@link

Полная ссылка на страницу.

@xlink:href

Ссылка UPage на страницу.

<total>

Общее количество страниц в указанном разделе.

<per_page>

Количество элементов, отображаемых на странице.

<parent_id>

Идентификатор раздела.

 

Вывод осуществляется по шаблону, указанному в параметре template (по умолчанию default.tpl).

Пример вызова

Простой вывод страниц: %content getList('default', 0)%.

Простой вывод страниц по пользовательскому шаблону: %content getList('sample', 0, 2, 10)%.

Используемые блоки шаблона

get_list_block

Общий блок для вывода страниц.

%total%

Общее количество страниц.

%per_page%

Количество элементов на странице.

%parent_id%

Идентификатор раздела.

%items%

Указывает место, куда будет выведен список страниц.

get_list_block_empty

Этот блок выводится когда нет ни одной доступной страницы.

get_list_item

Блок для вывода каждой страницы.

%id%

ID страницы.

%link%

Полная ссылка на страницу.

%name%

Название страницы.