Логотип

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

users list_users()

Название

%users list_users()% — Выводит список зарегистрированных и активированных пользователей.

Параметры: users list_users([template = 'default', per_page = '10'])

template

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

per_page

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

Описание

Макрос выводит список зарегистрированных и активированных пользователей. Количество выводимых на странице пользователей можно указать в параметре per_page

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

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

udata://users/list_users/notemplate/10

XML-ответ UData

<udata module="users" method="list_users" generation-time="0.006529">
  <items>
    <item id="14" xlink:href="uobject://14"/>
    <item id="2373" xlink:href="uobject://2373"/>
    <item id="27283" xlink:href="uobject://27283"/>
  </items>
  <total>3</total>
  <per_page>10</per_page>
</udata>

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

<items>

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

<item>

Элемент, описывающий отдельного пользователя из списка.

@id

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

@xlink:href

Ссылка UObject на пользователя.

<total>

Общее количество пользователей.

<per_page>

Количество пользователей, отображаемое на странице.

Вывод осуществляется по шаблону, указанному в параметре template.

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

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

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

block

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

%items%

Место, куда будет выведен список. Каждый пользователь выводится по блоку block_item текущего шаблона.

%per_page%

Количество пользователей на странице.

%total%

Общее количество зарегистрированных и активированных пользователей.

block_item

Блок для вывода каждого пользователя.

%user_id%

Id пользователя.

%list-class-first%

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

%list-class-last%

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

%list-class-odd%

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

%list-class-even%

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

%list-position%

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

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

Простой вывод списка пользователей по дефолтному шаблону: %users list_users()%.

Вывод списка по пользовательскому шаблону, по 50 на странице: %users list_users('sample', 50)%.

<?php

$FORMS['block'] = <<<END
 <ul>
  %items%
 </ul>

 %system numpages('%total%', '%per_page%', 'default')%
END;

$FORMS['block_item'] = <<<END
 <li>
  <a href="%pre_lang%/users/profile/%user_id%/">%login%</a>
 </li>
END;

?>