Вывод рейтингового голосования (rating.vote)

Описание и параметры

Компонент предназначен для вывода элементов рейтингового голосования и его текущих результатов. Компонент скрытый, его нельзя использовать через визуальный редактор.

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

<?$APPLICATION->IncludeComponent("bitrix:rating.vote","",
	Array(
		"ENTITY_TYPE_ID" => "FORUM_POST",
		"ENTITY_ID" => "1023",
		"OWNER_ID" => "4",
		"USER_HAS_VOTED" => "Y",
		"TOTAL_VOTES" => "18",
		"TOTAL_POSITIVE_VOTES" => "12",
		"TOTAL_NEGATIVE_VOTES" => "6",
		"TOTAL_VALUE" => "6",
		"PATH_TO_USER_PROFILE" => "/people/user/#USER_ID#/",
	),
	null,
	array("HIDE_ICONS" => "Y")
);?>

Описание параметров

Поле	Параметр	Описание
Объект голосования	ENTITY_TYPE_ID	Указывается название объекта, за которое будет идти голосование: USER - рейтингование пользователя; FORUM_TOPIC - рейтингование тем форума; FORUM_POST - рейтингование комментарий темы форума; BLOG_POST - сообщение в блоге; BLOG_COMMENT - комментарий к сообщению в блоге; IBLOCK_ELEMENT - элемент информационного блока (фотогалерея, библиотека документов, wiki).
Идентификатор объекта голосования	ENTITY_ID	Указывается идентификатор объекта.
Идентификатор пользователя - владельца объекта	OWNER_ID	Указывается идентификатор пользователя, которому принадлежит объект. Используется для блокировки возможности голосовать за себя.
Путь до профайла пользователей	PATH_TO_USER_PROFILE	Путь до профайла пользователей, например `/people/user/#USER_ID#/` (#USER_ID#, #user_id#, #UID# - переменная для замены на идентификатор пользователя).
Флаг голосования	USER_HAS_VOTED*	[Y\|N] Указывается статус голосования за объект текущим пользователем.
Количество голосов	TOTAL_VOTES*	Указывается количество голосов, отданных за объект.
Количество голосов "за"	TOTAL_POSITIVE_VOTES*	Указывается количество положительных голосов.
Количество голосов "против"	TOTAL_NEGATIVE_VOTES*	Указывается количество отрицательных голосов.
Результат голосования	TOTAL_VALUE*	Указывается итоговое значение голосования.
Вес голоса пользователя	USER_VOTE*	Указывается вес голоса пользователя.

Дополнительная информация

Если параметры, отмеченные звездочкой (*), не указывать, данные будут подгружены автоматически. Рекомендуется указывать параметры для случаев множественного вызова компонента (например, в списке комментариев).

Для выборки данных необходимо использовать функцию CRatings::GetRatingVoteResult или API следующих модулей:

Инфоблоки: CIBlockElement::GetList
Блоги: CBlogPost::GetList
Социальная сеть: CSocNetLogComments::GetList; CSocNetLog::GetList

Данные которые можно получать используя GetList указанных модулей:

Социальная сеть:

Параметр	Описание
RATING_TYPE_ID	Указывается название объекта, за которое будет идти голосование
RATING_ENTITY_ID	Указывается идентификатор объекта.
RATING_TOTAL_VALUE	Указывает итоговое значение голосования.
RATING_TOTAL_VOTES	Указывает количество голосов, отданных за объект.
RATING_TOTAL_POSITIVE_VOTES	Указывает количество положительных голосов.
RATING_TOTAL_NEGATIVE_VOTES	Указывает количество отрицательных голосов.
RATING_USER_VOTE_VALUE	Указывает с каким весом голосовал текущий пользователь.

Блоги и Инфоблоки:

Параметр	Описание
RATING_TOTAL_VALUE	Указывает итоговое значение голосования.
RATING_TOTAL_VOTES	Указывает количество голосов, отданных за объект.
RATING_TOTAL_POSITIVE_VOTES	Указывает количество положительных голосов.
RATING_TOTAL_NEGATIVE_VOTES	Указывает количество отрицательных голосов.
RATING_USER_VOTE_VALUE	Указывает с каким весом голосовал текущий пользователь.

Смотрите также:

Метод CRatings::GetRatingVoteResult