PHPackages                             vgalkin-dev/yii2-audit - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. vgalkin-dev/yii2-audit

ActiveYii2-extension[Framework](/categories/framework)

vgalkin-dev/yii2-audit
======================

Extensions to the Yii 2 PHP framework allowing tracking and viewing change history of a model.

0.1.0(2y ago)013.1k1MITPHP

Since Aug 26Pushed 2y agoCompare

[ Source](https://github.com/vgalkin-dev/yii2-audit)[ Packagist](https://packagist.org/packages/vgalkin-dev/yii2-audit)[ RSS](/packages/vgalkin-dev-yii2-audit/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (4)Versions (2)Used By (1)

yii2-audit
==========

[](#yii2-audit)

Extensions to the Yii 2 PHP framework allowing tracking and viewing change history of a model.

Changes are tracked using triggers, but model events should also be available as a fallback when using an unsupported database.

Provides:

- a model behavior:
    - loads older model versions
    - temporarily disabled tracking
- a command to manage and verify audit database objects
- a controller action with a view to view model change history

Installation
============

[](#installation)

Install via composer:

```
composer require nineinchnick/yii2-audit
```

Warning! If the database is restored from a dump, it's necessary to reenumaret table oids in `audits.logged_actions.relation_id` column using the following query:

```
UPDATE audits.logged_actions SET relation_id = (schema_name || '.' || table_name)::regclass::oid;
```

Recording changes
-----------------

[](#recording-changes)

Attach the behavior to the model, after the Blameable and Timestamp behaviors:

```
use yii\behaviors\BlameableBehavior;
use yii\behaviors\TimestampBehavior;
use nineinchnick\audit\behaviors\TrackableBehavior;

public function behaviors()
{
    return [
        BlameableBehavior::className(),
        TimestampBehavior::className(),
        [
            'class' => TrackableBehavior::className(),
            'mode' => TrackableBehavior::MODE_TRIGGER,
        ],
    ];
}
```

If using trigger mode, run a command that generates migrations, which would create or update database objects like triggers and audit tables.

First, configure the controller in your console config:

```
    'controllerMap' => [
        'audit' => [
            'class' => 'nineinchnick\audit\console\AuditController',
        ],
    ],
    // .... rest of configuration
```

Then run the command:

```
./yii audit/migration --modelName=AR_MODEL_CLASS
```

where `AR_MODEL_CLASS` is your model class name.

Displaying changes
------------------

[](#displaying-changes)

To view the change history, use the provided module in your app config:

```
    'modules' => [
        'audit' => [
            'class' => 'nineinchnick\audit\Module',
        ],
        // .... other modules
    ],
```

Sample configuration
====================

[](#sample-configuration)

```
'audit'      => [
    'class'   => 'nineinchnick\audit\Module',
    'tables'  => [
        'orders' => [
            'model'         => 'netis\orders\models\Order',
            'hiddenColumns' => ['id', 'created_on', 'author_id'],
            'updateSkip'    => ['updated_on', 'editor_id'],
            'relations'     => [
                'editor' => [
                    'type'                 => 'LEFT JOIN',
                    'table'                => '{{%users}}',
                    'on'                   => 'editor_id = u.id',
                    'alias'                => 'u',
                    'representive_columns' => 'username',
                    'label'                => Yii::t('models', 'Editor'),
                ],
            ]
        ],
    ],
    'filters' => [
        'dateFrom' => [
            'format'      => 'date',
            'attribute'   => 'operation_date',
            'widgetClass' => 'omnilight\widgets\DatePicker',
            'options'     => ['class' => 'form-control'],
            'dateFormat'  => 'yyyy-MM-dd',
            'rules'       => [
                [
                    'validator' => 'date',
                    'options'   => ['format' => 'Y-m-d'],
                ]
            ],
            'criteria'    => [
                'operator' => '>=',
            ],
        ],
        'dateTo'   => [
            'format'      => 'date',
            'attribute'   => 'operation_date',
            'widgetClass' => 'omnilight\widgets\DatePicker',
            'options'     => ['class' => 'form-control'],
            'dateFormat'  => 'yyyy-MM-dd',
            'rules'       => [
                [
                    'validator' => 'date',
                    'options'   => ['format' => 'Y-m-d'],
                ]
            ],
            'criteria'    => [
                'operator' => '