Download the PHP package rmrevin/yii2-comments without Composer
On this page you can find all versions of the php package rmrevin/yii2-comments. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package yii2-comments
Yii 2 Comments Module
Code Status
Installation
Configuration
In config /protected/config/main.php
In your User
model (or another model implements the interface IdentityInterface
) need to implement the interface "\rmrevin\yii\module\Comments\interfaces\CommentatorInterface"
In auth manager add rules (if Module::$useRbac = true
):
Updating database schema
After you downloaded and configured rmrevin/yii2-comments
,
the last thing you need to do is updating your database schema by applying the migrations:
In command line
:
Usage
In view
Parameters
Module parameters
-
userIdentityClass (required, string) The user identity class that Yii2 uses to provide identity information about the users in the App.
-
useRbac (optional, boolean) Default TRUE. Defines if the comment system will use Rbac validation to check the comment permissions when trying to update, delete or add new comments.
- modelClasses (optional, string[]) Stores the user defined model classes that will be used instead of the default ones in the comment system. Must have a key => classname format. e.g.
'Comment' => '@app\comments\CommentModel'
Widget parameters
-
entity (required, string) The entity that will identify the comments under on section from all the comments in this module.
-
theme (optional, string) In case you want to use a theme in your application you should define here it's location.
-
viewParams (optional, array) Data that will be sent directly into the widget view files. Must have a key => data format. The key will be the variable name in the view. The variable
CommentsDataProvider
it's already taken. -
options (optional, array) Default
['class' => 'comments-widget']
. Option data array that will be sent into the div holding the comment system in your views. -
pagination (optional, array) Pagination configuration that will be used in the comment panel. Default data:
-
sort (optional, array) Type of sorting used to retrieve the comments into the panel. Can be sorted by any of the columns defined in the
comment
table. Default data: -
showDeleted (optional, boolean) Default
True
. Defines if the comments panel will show a message indicating the deleted comments. - showCreateForm (optional, boolean) Default
True
. Will show or hide the form to add a comment in this panel.
Extending the package
Extending Model files
Depending on which ones you need, you can set the modelMap
config property:
Attention: keep in mind that if you are changing the Comment
model, the new class should always extend the package's original Comment
class.
Attaching behaviors and event handlers
The package allows you to attach behavior or event handler to any model. To do this you can set model map like so:
Extending View files
You can extend the view files supplied by this package using the theme
component in the config file.
Extending Widgets
To extend the widget code and behavior you only have to extend the widget classes and call them instead of the package's ones.