Yii Commentator модуль комментариев для Yii

Написал свой модуль комментариев для Yii, решил поделиться с вами! Пишите ваши предложения или вопросы в комментариях 🙂 Ссылка на модуль в конце записи.

Основные возможности модуля комментариев для Yii

• Поддержка лайков  +7 , которые так же могут уходить в «минус»
• Удаление своего комментария (даже без регистрации)
• Редактирование своего комментария (тоже без регистрации)
• Указание времени в течение которого можно отредактировать/удалить свой комментарий
• Указание уровня вложенности
• Указание отступа вложенности в пикселях
• Указание максимальной длины поля «автор» и «комментарий»
• Вкл/выкл возможности накрутки лайков суперпользователем
• Вкл/выкл режима «премодерации» комментариев
• Уведомление пользователя по e-mail о новых комментариях
• Пользователь может отписаться от получения комментариев с определённой страницы, или же со всего сайта
• Уведомление администратора по e-mail о новых комментариях
• Комментарии добавляются по ajax, без перезагрузки страницы
• Каждый комментарий имеет свою хэш-ссылку вида: site.com/your_url/#comment_7 (можно отправить друзьям)
• Для зарегистрированного пользователя показываются «новые комментарии»
• Поддержка микроразметки Schema.org

Yii Commentator предоставляет удобный менеджер управления комментариями

Демонстрация ответа на комментарий

Редактирование комментария

Просмотр комментария

Преимущества для разработчика

• Простая установка! Вам не нужно привязывать модуль к сущностям, вместо этого комментарии привязываются к странице на которой они расположены (как комментарии Вконтакте), это даёт невероятную гибкость и возможность разместить виджет комментариев на любой странице сайта!
• Лёгкое редактирование представлений (все части виджета удобно раскиданы по файликам)
• А также лёгкое редактирование шаблонов писем-уведомлений

Инструкция по установке

Установка производится с помощью Composer, если вы ещё не используете его, то срочно начинайте использовать! Экономит кучу времени и сил 😉

1. Выполняем команду Composer’a: php composer.phar require pendalf89/yii-commentator:dev-master
2. В index.php пишем: require_once('vendor/autoload.php'); Таким образом мы подключили автозагрузчик Composer’а

   // change the following paths if necessary
   $yii=dirname(__FILE__).'/framework/yii.php';
   $config=dirname(__FILE__).'/protected/config/main.php';
   
   // remove the following lines when in production mode
   defined('YII_DEBUG') or define('YII_DEBUG',true);
   // specify how many levels of call stack should be shown in each log message
   defined('YII_TRACE_LEVEL') or define('YII_TRACE_LEVEL',3);
   
   require_once('vendor/autoload.php');
   require_once($yii);
   Yii::createWebApplication($config)->run();
   

3. main/config.php:

   'aliases' => array(
       'comments' => realpath(dirname(__FILE__) . '/../..') . '/vendor/pendalf89/yii-commentator/',
   ),
   'modules'=>array(
       'comments' => array(
           'class' => 'pendalf89\yii_commentator\CommentsModule',
           'userModelClass' => '',
           'isSuperuser' => '!Yii::app()->user->isGuest',
       ),
   ),
   

   Про настройки подробнее будет написано ниже

4. Выполните миграции в папке vendor/pendalf89/yii-commentator/migrations

Зависимости

Модуль комментариев Yii commentator зависит от фронтенд фреймворка Twitter Bootstrap не ниже третьей версии и набора иконок FontAwesome.

Настройки

Вы можете использовать настройки класса модуля, или же использовать настройки из базы данных. Приоритет определяется свойством ‘useSettingsFromDB’

Настройки модуля комментариев Yii commentator

Название настройки	Значение по-умолчанию	Описание
dateFormat	‘d.m.Y | H:i:s’	Формат даты
margin	70	Отступ комментария от левого края
levels	6	Максимальное количество уровней дерева комментариев
editTime	60	Лимит времени в секундах, в течение которого разрешено редактировать/удалять свой комментарий
maxLengthAuthor	128	Максимальная длина поля «автор». Максимум — 128 символов
maxLengthContent	1000	Максимальная длина поля «комментарий»
likesControl	false	Возможность суперпользователя накручивать лайки
premoderate	false	Премодерация комментариев (если true, то появляются на сайте только после проверки)
fromEmail	—	E-mail с которого пользователям приходят сообщения
adminEmail	—	E-mail, на который администратору приходят уведомления
notifyAdmin	false	Уведомлять администратора о новых комментариях или нет
isSuperuser	‘\Yii::app()->user->checkAccess(«admin»)’	Выражение или анонимная функция, которая определяет что текущий пользователь является супер пользователем. Анонимная функция должна возвращать true/false
managePageSize	50	Количество комментариев, отображаемых на странице управления комментариями
useSettingsFromDB	true	Использовать настройки, задаваемые в конфиге, или же брать их из БД
userIDExpr	‘\Yii::app()->user->id’	Выражение или анонимная функция для получения id текущего пользователя
userModelClass	‘User’	Класс моделей пользователей. Если у вас нет модели пользователей, оставьте это значение пустым, модуль будет работать без модели пользователей
userEmailField	’email’	Свойство модели пользователя, в котором хранится email пользователя
usernameField	‘username’	Свойство модели пользователя, в котором хранится имя пользователя

Использование

Теперь можно подключить виджет комментариев на любую страницу!

$this->widget('pendalf89\yii_commentator\extensions\comments_widget\CommentsWidget', array(
     // Необязательный параметр, включает поддержку микроразметки, по-умолчанию: false
    'enableMicrodata' => true,
));

Этот код выведет форму комментирования и сами комментарии. Вы также можете вывести количество новых комментариев с помощью виджет CommentsCount:

// Новые комментарии в оформленном виде
$this->widget('pendalf89\yii_commentator\extensions\count_widget\CountWidget');
// Количество новых комментариев:
pendalf89\yii_commentator\helpers\CHelper::getNewCommentsCount();
// Ссылка на последний новый комментарий
pendalf89\yii_commentator\helpers\CHelper::getNewCommentsUrl()

Скачать Yii Commentator модуль комментариев для Yii

Скачать готовый пример модуля комментариев

Проект Yii Commentator на GitHub’е