Логотип

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

vote getElementRating()

Название

%vote getElementRating()% — Возвращает рейтинг страницы.

Параметры: vote getElementRating([template = "default"], elementId = null)

template

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

elementId

Идентификатор страницы, рейтинг которой необходимо узнать.

Описание

Макрос выводит рейтинг страницы, идентификатор которой передан в параметре elementId. Если elementId не передан, то выводится рейтинг текущей страницы. Если страница с идентификатором elementId не существует на сайте, то макрос выведет сообщение об ошибке.


Примечание: Для переключения режима рейтингования с 2-балльного на 5-балльный воспользуйтесь опцией Сделать 5-балльные рейтинги в Настройках модуля "Опросы".

<?=$this->render($this->macros('vote', 'getElementRating', array(null, $page->getId())), 'vote/elementrating')?>

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

udata://vote/getElementRating/notemplate/3

XML-ответ UData


<udata module="vote" method="getElementRating" generation-time="0.053591">
<element_id>3/<element_id>
<rate_sum>5</rate_sum>
<rate_voters>1</rate_voters>
<rate>5</rate>
<ceil_rate>5</ceil_rate>
</udata>

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

element_id

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

rate_sum

Суммарный рейтинг данной страницы.

rate_voters

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

rate

Текущий рейтинг.

ceil_rate

Округленное значение рейтинга.

 

Вывод рейтинга осуществяется по шаблону, указанному в параметре template. Вы можете не указывать этот параметр, в этом случае для вывода опроса будет использован шаблон по умолчанию — default.tpl.

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

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

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

rate_rating_permitted

Отвечает за вывод сообщения о том, что голосование запрещено для неавторизованного пользователя.

%element_id%

id страницы.

%rate_sum%

Суммарный рейтинг.

%rate_voters%

Количество проголосовавших.

%rate%

Текущий рейтинг.

%ceil_rate%

Округленное значение рейтинга.

rate_not_found

Отвечает за вывод сообщения об ошибке при голосовании.

rate_rating_graded

Отвечает за вывод пятибалльного типа голосования для пользователя, которому разрешено проголосовать.

%element_id%

id страницы.

%rate_sum%

Суммарный рейтинг.

%rate_voters%

Количество проголосовавших.

%rate%

Текущий рейтинг.

%ceil_rate%

Округленное значение рейтинга.

rate_rating

Отвечает за вывод двухбалльного рейтинга, когда пользователю разрешено проголосовать.

%element_id%

id страницы.

%rate_sum%

Суммарный рейтинг.

%rate_voters%

Количество проголосовавших.

%rate%

Текущий рейтинг.

%ceil_rate%

Округленное значение рейтинга.

 

rate_rated_graded

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

%element_id%

id страницы.

%rate_sum%

Суммарный рейтинг.

%rate_voters%

Количество проголосовавших.

%rate%

Текущий рейтинг.

%ceil_rate%

Округленное значение рейтинга.

rate_rated

Отвечает за вывод двухбалльного рейтинга для пользователя, который уже проголосовал.

%element_id%

id страницы.

%rate_sum%

Суммарный рейтинг.

%rate_voters%

Количество проголосовавших.

%rate%

Текущий рейтинг.

%ceil_rate%

Округленное значение рейтинга.