This bundle creates audit logs for all doctrine ORM database related changes:
- inserts and updates including their diffs and relation field diffs.
- many to many relation changes, association and dissociation actions.
- if there is an user in token storage, it is used to identify the user who made the changes.
- the audit entries are inserted within the same transaction during flush, if something fails the state remains clean.
Basically you can track any change from these log entries if they were managed through standard ORM operations.
NOTE: audit cannot track DQL or direct SQL updates or delete statement executions.
This bundle is inspired by data-dog/audit-bundle and simplethings/entity-audit-bundle
Open a command console, enter your project directory and execute:
composer require composer require damienharper/doctrine-audit-bundle
Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:
composer require composer require damienharper/doctrine-audit-bundle
This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.
Then, enable the bundle by adding it to the list of registered bundles
in the app/AppKernel.php
file of your project:
<?php
// app/AppKernel.php
// ...
class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = array(
// ...
new DH\DoctrineAuditBundle\DHDoctrineAuditBundle(),
);
// ...
}
// ...
}
By default, DoctrineAuditBundle won't audit any entity, you have to configure which entities have to be audited.
// app/config/config.yml (symfony < 3.4)
// config/dh_doctrine_audit.yaml (symfony >= 3.4)
dh_doctrine_audit:
entities:
MyBundle\Entity\MyAuditedEntity1: ~
MyBundle\Entity\MyAuditedEntity2: ~
All MyAuditedEntity1
and MyAuditedEntity2
properties will be audited.
Though it is possible to exclude some of them from the audit process.
// app/config/config.yml (symfony < 3.4)
// config/dh_doctrine_audit.yaml (symfony >= 3.4)
dh_doctrine_audit:
entities:
MyBundle\Entity\MyAuditedEntity1: ~ # all MyAuditedEntity1 properties are audited
MyBundle\Entity\MyAuditedEntity2:
ignored_columns: # properties ignored by the audit process
- created_at
- updated_at
It is also possible to specify properties that are globally ignored by the audit process.
// app/config/config.yml (symfony < 3.4)
// config/dh_doctrine_audit.yaml (symfony >= 3.4)
dh_doctrine_audit:
ignored_columns: # properties ignored by the audit process in any audited entity
- created_at
- updated_at
Audit table names are composed of a prefix, the audited table name and a suffix.
By default, the prefix is empty and the suffix is _audit
. Though, they can be customized.
// app/config/config.yml (symfony < 3.4)
// config/dh_doctrine_audit.yaml (symfony >= 3.4)
dh_doctrine_audit:
table_prefix: ''
table_suffix: '_audit'
Open a command console, enter your project directory and execute the following command to review the new audit tables in the update schema queue.
# symfony < 3.4
app/console doctrine:schema:update --dump-sql
# symfony >= 3.4
bin/console doctrine:schema:update --dump-sql
Notice: DoctrineAuditBundle currently only works with a DBAL Connection and EntityManager named "default".
# symfony < 3.4
app/console doctrine:migrations:diff
app/console doctrine:migrations:migrate
# symfony >= 3.4
bin/console doctrine:migrations:diff
bin/console doctrine:migrations:migrate
# symfony < 3.4
app/console doctrine:schema:update --force
# symfony >= 3.4
bin/console doctrine:schema:update --force
Add the following routes to the routing configuration to enable the included audits viewer.
// app/config/routing.yml (symfony < 3.4)
// config/routes.yaml (symfony >= 3.4)
dh_doctrine_audit:
resource: "@DHDoctrineAuditBundle/Controller/"
type: annotation
audit entities will be mapped automatically if you run schema update or similar. And all the database changes will be reflected in the audit logs afterwards.
DoctrineAuditBundle provides a convenient command that helps you cleaning audit tables. Open a command console, enter your project directory and execute:
# symfony < 3.4
app/console audit:clean
# symfony >= 3.4
bin/console audit:clean
By default it cleans audit entries older than 12 months. You can override this by providing the number of months you want to keep in the audit tables. For example, to keep 18 months:
# symfony < 3.4
app/console audit:clean 18
# symfony >= 3.4
bin/console audit:clean 18
It is also possible to bypass the confirmation and make the command un-interactive if you plan to schedule it (ie. cron)
# symfony < 3.4
app/console audit:clean --no-confirm
# symfony >= 3.4
bin/console audit:clean --no-confirm
DoctrineAuditBundle is free to use and is licensed under the MIT license