Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yii2mod/yii2-comments
Comments module for Yii2
https://github.com/yii2mod/yii2-comments
yii2 yii2-comments yii2-comments-module yii2-comments-system yii2-extension
Last synced: 2 days ago
JSON representation
Comments module for Yii2
- Host: GitHub
- URL: https://github.com/yii2mod/yii2-comments
- Owner: yii2mod
- License: mit
- Created: 2015-07-31T13:00:18.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-06-28T03:59:37.000Z (over 1 year ago)
- Last Synced: 2025-01-03T18:08:49.041Z (9 days ago)
- Topics: yii2, yii2-comments, yii2-comments-module, yii2-comments-system, yii2-extension
- Language: PHP
- Size: 180 KB
- Stars: 159
- Watchers: 25
- Forks: 63
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-yii2 - yii2mod/yii2-comments - Comments module. (Modules)
README
Yii2 Comments Extension
This module provides a comments managing system.
[](https://packagist.org/packages/yii2mod/yii2-comments)
[](https://packagist.org/packages/yii2mod/yii2-comments)
[](https://packagist.org/packages/yii2mod/yii2-comments)
[](https://travis-ci.org/yii2mod/yii2-comments)
[](https://scrutinizer-ci.com/g/yii2mod/yii2-comments/?branch=master)
## Support us
Does your business depend on our contributions? Reach out and support us on [Patreon](https://www.patreon.com/yii2mod).
All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist yii2mod/yii2-comments "*"
```
or add
```
"yii2mod/yii2-comments": "*"
```
to the require section of your composer.json.
Configuration
-----------------------
**Database Migrations**
Before using Comments Widget, we'll also need to prepare the database.
```php
php yii migrate --migrationPath=@vendor/yii2mod/yii2-comments/migrations
```
**Module setup**
To access the module, you need to add the following code to your application configuration:
```php
'modules' => [
'comment' => [
'class' => 'yii2mod\comments\Module',
],
]
```
>**NOTE:** Module id must be `comment` and not otherwise. This is because it is referred [somewhere](https://github.com/yii2mod/yii2-comments/blob/master/traits/ModuleTrait.php#L20) in the code with such name. A PR to fix it to use configured module id is welcome.
Now you can access to management section through the following URL:
http://localhost/path/to/index.php?r=comments/index
> By default only users with `admin` role have access to comments management section. But, you can override `accessControlConfig` property for ManageController.
**Notes:**
> 1) Delete button visible only for users with `admin` role.
> 2) When you delete a comment, all nested comments will be marked as `deleted`.
> 3) You can override default CommentModel class by changing the property `commentModelClass` in the Comment Module.
> 4) You can implement your own methods `getAvatar` and `getUsername` in the `userIdentityClass`. Just create this methods in your User model. For example:
```php
public function getAvatar()
{
// your custom code
}
public function getUsername()
{
// your custom code
}
```
Usage
-------------------
**Basic example:**
```php
// the model to which are added comments, for example:
$model = Post::find()->where(['title' => 'some post title'])->one();
$model,
]); ?>
```
**You can use your own template for render comments:**
```php
$model,
'commentView' => '@app/views/site/comments/index' // path to your template
]); ?>
```
**Use the following code for multiple widgets on the same page:**
```php
$model,
]); ?>
$model2,
'formId' => 'comment-form2',
'pjaxContainerId' => 'unique-pjax-container-id'
]); ?>
```
**To enable the pagination for comments list use the following code:**
```php
$model,
'dataProviderConfig' => [
'pagination' => [
'pageSize' => 10
],
]
]); ?>
```
**Advanced example:**
```php
$model,
'relatedTo' => 'User ' . \Yii::$app->user->identity->username . ' commented on the page ' . \yii\helpers\Url::current(),
'maxLevel' => 2,
'dataProviderConfig' => [
'pagination' => [
'pageSize' => 10
],
],
'listViewConfig' => [
'emptyText' => Yii::t('app', 'No comments found.'),
],
]); ?>
```
## Using Events
You may use the following events:
```php
'modules' => [
'comment' => [
'class' => 'yii2mod\comments\Module',
'controllerMap' => [
'default' => [
'class' => 'yii2mod\comments\controllers\DefaultController',
'on beforeCreate' => function ($event) {
$event->getCommentModel();
// your custom code
},
'on afterCreate' => function ($event) {
$event->getCommentModel();
// your custom code
},
'on beforeDelete' => function ($event) {
$event->getCommentModel();
// your custom code
},
'on afterDelete' => function ($event) {
$event->getCommentModel();
// your custom code
},
]
]
]
]
```
## Using Comment Plugin Events
```js
$(document).on('beforeCreate', '#comment-form', function (e) {
if (!confirm("Everything is correct. Submit?")) {
return false;
}
return true;
});
```
Available events are:
* beforeCreate
* afterCreate
* beforeDelete
* afterDelete
* beforeReply
* afterReply
## Internationalization
All text and messages introduced in this extension are translatable under category 'yii2mod.comments'.
You may use translations provided within this extension, using following application configuration:
```php
return [
'components' => [
'i18n' => [
'translations' => [
'yii2mod.comments' => [
'class' => 'yii\i18n\PhpMessageSource',
'basePath' => '@yii2mod/comments/messages',
],
// ...
],
],
// ...
],
// ...
];
```
#### Example comments
-----
