Download the PHP package yii2mod/yii2-moderation without Composer
On this page you can find all versions of the php package yii2mod/yii2-moderation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yii2mod/yii2-moderation
More information about yii2mod/yii2-moderation
Files in yii2mod/yii2-moderation
Package yii2-moderation
Short Description A simple Content Moderation System for Yii2 that allows you to Approve or Reject resources like posts, comments, etc.
License MIT
Informations about the package yii2-moderation
Yii2 Moderation Extension
A simple Content Moderation System for Yii2 that allows you to Approve or Reject resources like posts, comments, etc.
Installation
The preferred way to install this extension is through composer.
Either run
or add
to the require section of your composer.json.
Configuration
To enable moderation for a model, use the yii2mod\moderation\ModerationBehavior
behavior and add the status
and moderated_by
columns to your model's table.
Create a migration to add the new columns. Example Migration:
To use ModerationBehavior, insert the following code to your ActiveRecord class:
By default, ModerationBehavior will automatically set the moderated_by
attribute.
If your attribute names are different, you may configure the [[statusAttribute]] and [[moderatedByAttribute]] properties like the following:
Usage
In next examples I will use Post model to demonstrate how the behavior and query class works. You can moderate any ActiveRecord Model.
Moderate Models
ModerationBehavior provides the following methods for model moderation:
Model Status
ModerationBehavior also provides the following methods for checking the moderation status:
Events
By default [[yii2mod\moderation\ModerationBehavior]] triggers [[yii2mod\moderation\ModerationBehavior::EVENT_BEFORE_MODERATION]]
You may attach the event handlers for this event to your ActiveRecord object:
You may also handle these events inside your ActiveRecord class by declaring the corresponding method:
Query Models
ModerationQuery
adds the ability of getting only approved, rejected, postponed or pending models. Usage example:
Now you can use the following methods:
Support us
Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.