asinfotrack/yii2-comments

Yii2-comments is a behavior and a set of widgets to enable generic commenting on Yii2-ActiveRecord-Models

Yii2-comments

Yii2-comments is a behavior and a set of widgets to enable commenting on Yii2-ActiveRecord-Models, _(*1)

Advantages

This is not the first commenting extension. So why use this one? Those are some of the major advantages:, _(*2)

• this extension works with composite primary keys
• the handling and configuration couldn't be simpler
• awesome widgets to show, list and add comments

Installation

The preferred way to install this extension is through composer., _(*3)

Either run, _(*4)

$ composer require asinfotrack/yii2-comments

or add, _(*5)

"asinfotrack/yii2-comments": "~0.8.2"

to the require section of your composer.json file., _(*6)

Migration

After downloading everything you need to apply the migration creating the audit trail entry table:, _(*7)

yii migrate --migrationPath=@vendor/asinfotrack/yii2-comments/migrations

To remove the table just do the same migration downwards., _(*8)

Usage

Behavior

Attach the behavior to your model and you're done:, _(*9)

public function behaviors()
{
    return [
        // ...
        'comments'=>[
            'class'=>CommentBehavior::class,

            //TODO: comment this
        ],
        // ...
    ];
}

Widget

The widget is also very easy to use. Just provide the model to get the audit trail for:, _(*10)

<?= Comments::widget([
    'model'=>$model,

    // some of the optional configurations
    //TODO: comment this
]) ?>

Changelog

Learn about the latest improvements., _(*11)