Records changes made to an object during CRUD operations.
Check out Audit log API Documentation
A logging plugin for CakePHP. The included AuditableBehavior
creates an audit history for each instance of a model to which it's attached.
The behavior tracks changes on two levels. It takes a snapshot of the fully hydrated object after a change is complete and it also records each individual change in the case of an update action.
created
, updated
and modified
are ignored by default, but these values can be overwritten.PolymorphicBehavior
.AuditLog
) and deltas (AuditLogDeltas
).app/Plugin/AuditLog
.$ git submodule add git://github.com/imsamurai/CakePHP-Audit-Log-Plugin.git <path_to>/app/Plugin/AuditLog
$ git submodule init
$ git submodule update
composer update
To create tables you can use schema shell. To create tables execute:
cd <path_to>/app/
chmod +x ./Console/cake
./Console/cake schema create -p AuditLog
For use with CakePHP 1.3.x, be sure to use code from the 1.3
branch and follow the instructions in that README file (NOT MAINTAINED).
install.sql
file on your CakePHP application database or use schema. This will create the audits
and audit_deltas
tables that will store each object's relevant change history.Add plugin into bootstrap.php
CakePlugin::load('AuditLog', array('bootstrap' => true));
Create a currentUser()
method, if desired.
The AuditableBehavior
optionally allows each changeset to be "owned" by a "source" -- typically the user responsible for the change. Since user and authentication models vary widely, the behavior supports a callback method that should return the value to be stored as the source of the change, if any.
The currentUser()
method must be available to every model that cares to track a source of changes, so I recommend that a copy of CakePHP's app_model.php
file be created and the method added there. Keep it DRY, right?
The behavior expects the currentUser()
method to return an associative array with an id
key. Continuing from the example above, the following code might appear in the AppModel
:
public function currentUser() {
return AuthComponent::user();
}
Applying the AuditableBehavior
to a model is essentially the same as applying any other CakePHP behavior. The behavior does offer a few configuration options:
user(user)
render user name with link to user profile (see config AuditLog.User
)listBlock(conditions, ajax)
render widget with compact table of audit logs depends on conditions
and ajax
. Second parameter means that widget will be loaded by ajax or request action (default is ajax). This method simply invoke action AuditController::index
with list=1
and conditions
(also count=<count>
if it set).# Simple syntax accepting default options
class Task extends AppModel {
public $actsAs = array( 'AuditLog.Auditable' );
#
# Additional model code.
#
}
# Syntax with explicit options
class Task extends AppModel {
public $actsAs = array(
'AuditLog.Auditable' => array(
'ignore' => array( 'active', 'name', 'updated' ),
'habtm' => array( 'Type', 'Project' )
)
);
#
# Additional model code.
#
}
1.3
branch and follow the instructions in that README. This code is licensed under the MIT license.
Feel free to submit bug reports or suggest improvements in a ticket or fork this project and improve upon it yourself. Contributions welcome.
view all
in widget