Логотип

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

catalog getCategoryList()

Название

%catalog getCategoryList()% — Выводит список подразделов в указанном разделе каталога.

Параметры: catalog getCategoryList( [template = 'default', category_id = 0, limit = 0, ignore_paging = 0, i_need_deep = 0] )

template

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

category_id

Id или путь до раздела каталога.

limit

Количество подразделов, выводимых на странице.

ignore_paging

Игнорировать переход по страницам. Если поставить значение этого параметра равным "1", и в URL страницы будет присутствовать параметр p, то для этого макроса он будет проигнорирован.

i_need_deep

Глубина поиска объектов списка (во вложенных подразделах). По умолчанию — только в текущем разделе.

Описание

Макрос выводит подразделы в указанном разделе (параметр category_id). Если параметр category_id не указан, берется id текущей страницы. Количество подразделов на странице можно ограничить параметром limit. Если параметр не указан, выведется количество элементов, указанное в настройках модуля.

Дополнительные сведения

<?=$this->render($this->macros('catalog', 'getCategoryList', array('void', 'shop', '', 1)), 'catalog/maincategorylist')?>

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

udata://catalog/getCategoryList/notemplate/(market)/10

XML-ответ UData

<udata module="catalog" method="getCategoryList" generation-time="0.006517">
  <items>
    <item id="44" link="/market/hamsters/"
     xlink:href="upage://44">Хомячки</item>
    <item id="55" link="/market/aksessuary_dlya_homyachkov/"
     xlink:href="upage://55">Аксессуары для хомячков</item>
  </items>
  <total>2</total>
  <per_page>10</per_page>
</udata>

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

<items>

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

<item>

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

@id

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

@link

Ссылка на подраздел.

@xlink:href

Ссылка upage на страницу подраздела.

<total>

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

<per_page>

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

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

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

Простой вывод подразделов: %catalog getCategoryList('default', '/cars/')%.

Простой вывод подразделов по пользовательскому шаблону: %catalog getCategoryList('sample', '/cars/', 10)%.

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

category_block

Общий блок для вывода подразделов.

%lines%

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

%per_page%

Количество объектов на странице.

%total%

Общее количество объектов.

category_block_empty

Этот блок выводится, когда нет ни одного подраздела.

category_block_line

Блок для вывода каждого подраздела

%id%

id подраздела.

%link%

Url подраздела.

%text%

Имя подраздела.

%list-class-first%

в случае, если элемент первый, выводит "first"

%list-class-last%

в случае, если элемент последний, выводит "last"

%list-class-odd%

в случае, если элемент четный, выводит "odd"

%list-class-even%

в случае, если элемент нечетный, выводит "even"

%list-position%

вставляет порядковый номер в списке