Логотип

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

photoalbum albums()

Название

%photoalbum albums()% — Выводит список всех фотоальбомов.

Параметры: photoalbum albums([template = 'default', limit = '0', ignore_paging = '0', parentElementId = '0', order = 'asc'])

template

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

limit

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

ignore_paging

Игнорировать пейджинг (параметр ?p=1 в URL)

parentElementId

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

order

Порядок вывода элементов. В качестве значения можно передать asc (прямой порядок), desc (обратный порядок) и rand (случайный порядок).

Описание

Макрос выводит список всех фотоальбомов.

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

Для получения свойств каждого фотоальбома из списка, можно воспользоваться протоколом UPage (см. «Страницы: протокол UPage»).

Например, запрос "upage://33.desc" для фотоальбома с id=33 вернет следующее:

<udata generation-time="0.002570">
  <property id="8893" name="descr" type="wysiwyg">
    <title>Описание</title>
    <value>Наши любимые фотографии.</value>
  </property>
</udata>

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

udata://photoalbum/albums/

XML-ответ UData

<udata module="photoalbum" method="albums" generation-time="0.008595">
  <items>
    <item id="33" link="/butterfly/" xlink:href="upage://33">Фотогалерея</item>
    <item id="100" link="/ewe_odna_fotogalereya/" xlink:href="upage://100">Еще одна фотогалерея</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.

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

Макрос оперирует шаблонами, находящимися в каталоге /tpls/photalbum/.

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

albums_list_block

Общий блок для вывода всего списка фотоальбомов.

%lines%

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

%total%

Общее количество фотоальбомов.

albums_list_block_empty

Данный блок выводится, если у Вас нет ни одного созданного активного фотоальбома.

albums_list_block_line

Блок для вывода информации о каждом фотоальбоме.

%name%

Имя фотоальбома.

%link%

URL адрес содержимого фотоальбома.

%list-class-first%

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

%list-class-last%

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

%list-class-odd%

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

%list-class-even%

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

%list-position%

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

Примеры использования

Создайте файл sample.tpl в директории /tpls/photoalbum/ и напишите в нем следующий код:

<?php

$FORMS = Array();

$FORMS['albums_list_block'] = <<<END

Список альбомов:

 <ul>
  %lines%
 </ul>

END;

$FORMS['albums_list_block_empty'] = <<<END

Фотоальбомов нет.

END;

$FORMS['albums_list_block_line'] = <<<END

 <li>
  <a href="%link%">%name%</a>
 </li>

END;

?>

Создайте страницу «Мои фотоальбомы» в модуле «Структура». В редакторе содержимого страницы введите макрос %photoalbum albums('sample')%. Сохраните страницу. Теперь на созданной странице должен появиться список фотоальбомов.