Skip to content
This extension adds storage history of changes to the ActiveRecord model.
Branch: master
Clone or download
Latest commit 264b727 Jul 10, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Changed some methods visibility properties for make History behavior … Jul 10, 2019
tests fixed tests Oct 24, 2018
.gitignore 1.1.2 Oct 24, 2018
.php_cs 1.1.0 Feb 24, 2018
.travis.yml 1.1.2 Oct 24, 2018 1.2.0 Jul 10, 2019 Update Jun 4, 2018
composer.json 1.2.0 Jul 10, 2019
phpunit.xml.dist 1.1.2 Oct 24, 2018


Latest Stable Version Total Downloads Latest Unstable Version License Build Status Coverage Status

This extension adds storage history of changes to the ActiveRecord model.

Extension can tacking changes to model and save to storage. Allowed only storage to database. All changes saved to table in database.


The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist bupy7/yii2-activerecord-history "*"

or add

"bupy7/yii2-activerecord-history": "*"

to the require section of your composer.json file.


NOTICE! Configuration of module must have in common/config/main.php if you will use andanced template. Or add configuration in both config/web.php and config/console.php if you will use basic template.

Register of module to config file:

'modules' => [
    'arhistory' => [
        'class' => 'bupy7\activerecord\history\Module',

Name of module can be any (example: history, custom-name and etc).

Add module in bootstrap to config file:

'bootstrap' => ['arhistory'],

Run migration:

php ./yii migrate/up --migrationPath=@bupy7/activerecord/history/migrations

Attach behavior to model:

use bupy7\activerecord\history\behaviors\History as HistoryBehavior;

$model->attachBehavior('arHistory', HistoryBehavior::className());


Module configuration:

'modules' => [
    'arhistory' => [
        'class' => 'bupy7\activerecord\history\Module',
        'tableName' => '{{%arhistory}}', // table name of saving changes of model
        'storage' => 'bupy7\activerecord\history\storages\Database', // class name of storage for saving history of active record model
        'db' => 'db', // database connection component config or name
        'user' => 'user', // authentication component config or name

Behavior configuration:

use bupy7\activerecord\history\behaviors\History as HistoryBehavior;

$model->attachBehavior('arHistory', [
    'class' => HistoryBehavior::className(),
    // allowed events list than are monitored and saved in storage.
    'allowEvents' => [
    // list of attributes which not need track at updating. Apply only for `HistoryBehavior::EVENT_UPDATE`.
    'skipAttributes' => [
    // list of custom attributes which which are a pair of `key`=>`value` where `key` is attribute name and
    // `value` it anonymous callback function of attribute. Function will be apply for old and value information data.
    // Apply only for `HistoryBehavior::EVENT_UPDATE`.
    'customAttributes' => [
        'name_of_attribute_3' => function($event, $isNewValue) {
            if ($isNewValue) {
                return $event->sender->name_of_attribute_3; 
            return $event->changedAttributes['name_of_attribute_3'];


yii2-activerecord-history is released under the BSD 3-Clause License.

You can’t perform that action at this time.