Skip to content

Latest commit

 

History

History
65 lines (60 loc) · 3.93 KB

README.md

File metadata and controls

65 lines (60 loc) · 3.93 KB
Raw

ylab.likes

Модуль реализует функционал лайков/дизлайков для любых сущностей битрикс.

Разработчик: Alexandr Zemlyanoy (Galamoon)

API

ID типа контента определяется произвольно в рамках проекта

php

  • ORM класс Ylab\Likes\YlabLikesTable
    • Константы
      • VoteDislike - Значение дизлайка
      • VoteLike - Значение лайка
    • Методы
      • public static function setLike($iContentId, $iContentType, $iUserId) - Делает запись голоса типа (лайк)
        • $iContentId - ID контента
        • $iContentType - ID типа контента
        • $iUserId - ID пользователя от имени которого будет отдан голос
      • public static function setDislike($iContentId, $iContentType, $iUserId) - Делает запись голоса типа (дизлайк)
        • $iContentId - ID контента
        • $iContentType - ID типа контента
        • $iUserId - ID пользователя от имени которого будет отдан голос
      • public static function getContentStat($mContentId, $iContentType, $iUserLike = null) - Получает данные о количестве голосов контента
        • $mContentId - ID или массив ID контента.
        • $iContentType - Ид типа контента
        • $iUserLike - (необязательный) ID пользователя для которого будет получено значение его голоса

js

Подключение библиотеки js CJSCore::Init(['YlabLikesForm']);

  • Библиотека YlabLikesForm
    • Методы
      • BX.Ylab.Likes.setAjaxPath(AjaxPath) - Изменить пути к php обработчикам событий
        • AjaxPath - По умолчанию 
          {
    "setLike": "/bitrix/themes/ylab.likes/ajax/setLike.php",
    "setDislike": "/bitrix/themes/ylab.likes/ajax/setDislike.php",
    "getContentStat": "/bitrix/themes/ylab.likes/ajax/getContentStat.php"
}
      • BX.Ylab.Likes.setLike(iContentId, iContentType, oCallback) - Делает запись голоса типа (лайк) от имени текущего пользователя
        • iContentId - ID контента
        • iContentType - ID типа контента
        • oCallback - Функция коллбек будет вызвана после отправки запроса
      • BX.Ylab.Likes.setDislike(iContentId, iContentType, oCallback) - Делает запись голоса типа (дизлайк) от имени текущего пользователя
        • iContentId - ID контента
        • iContentType - ID типа контента
        • oCallback - Функция коллбек будет вызвана после отправки запроса
      • BX.Ylab.Likes.getContentStat(iContentId, iContentType, oCallback) - Получает данные о количестве голосов контента и голосе текущего пользователя
        • iContentId - ID контента
        • iContentType - ID типа контента
        • oCallback - Функция коллбек будет вызвана после отправки запроса

Bitrix component

Компонент уже содержит все необходимое для начала работы. Пример использования компонента.

<?
$APPLICATION->IncludeComponent("ylab:likes", "", [
    'ELEMENT_ID' => '' /* ID контента */,
    'ENTITY_ID' => ''/* ID типа контента */,
    'CACHE_TYPE' => 'А',
    'CACHE_TIME' => 300
]);
?>