Active record changelog extension for Yii 2 framework

This extension provides a changelog functional., _(*1)

For license information check the LICENSE-file., _(*2)

Support

Installation

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

Either run, _(*4)

composer require "rmrevin/yii2-changelog:~1.0"

or add, _(*5)

"rmrevin/yii2-changelog": "~1.0",

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

Execute migrations:, _(*7)

php yii migrate --migrationPath=@rmrevin/yii/changelog/migrations

Usage

To view the history, you can use a special panel for debug. Or make your own section to view the data in your administration panel., _(*8)

To enable the debug panel, add the following code in the module configuration debug., _(*9)

    'modules' => [
        // ...
        'debug' => [
            'class' => yii\debug\Module::className(),
            'panels' => [
                rmrevin\yii\changelog\debug\panels\ChangelogPanel::class,
            ],
        ],
    ],

For ActiveRecord models for which you want to track changes, you must implement the interface rmrevin\yii\changelog\interfaces\LoggableInterface and add the behavior of rmrevin\yii\changelog\behaviors\ChangelogBehavior., _(*10)

Example:, _(*11)

<?php

use rmrevin\yii\changelog\interfaces\LoggableInterface;
use rmrevin\yii\changelog\behaviors\ChangelogBehavior;
use yii\db\ActiveRecord;

/**
 * Class ShopItem
 *
 * @property integer $id
 * @property integer $number
 * @property string $title
 * @property integer $created_at
 * @property integer $updated_at
 * @property integer $synchronized_at
 */
class ShopItem extends ActiveRecord implements LoggableInterface
{

    /**
     * @inheritdoc
     */
    public function __toString()
    {
        return sprintf('[%s] %s', $this->number, $this->title);
    }

    /**
     * @inheritdoc
     */
    public function behaviors()
    {
        return [
            // ...
            [
                'class' => ChangelogBehavior::class,
                'ignoreAttributes' => [ // these attributes are not tracked
                    'updated_at',
                    'synchronized_at',
                ],
            ],
        ];
    }
}

Done

Now when you try to create, modify or delete an instance of a model ShopItem in the table {{%changelog}} will be recorded relevant information., _(*12)