Skip to content

Commit

Permalink
Updated documentation and CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DamienHarper committed Oct 30, 2019
1 parent 9551aa3 commit b41c7af
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
11 changes: 6 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,22 @@ using annotations in entities.
* **Audit events**: an audit event is dispatched for every audit entry opening the doors to add
custom behavior on audit entry creation.
* **Security controls**: audit access can be now restricted to specific roles.
* The bundle now supports non numeric IDs for the `User` objects (closes #66, thanks to @Gonzalo1987).
* The bundle now supports non numeric IDs for the `User` objects (thanks to @Gonzalo1987).
* A transaction hash is now stored in audit tables and makes it easier to identify all operations performed
in the same transaction (closes #69)
in the same transaction
- The timeline now displays a transaction hash for each element. By clicking a transaction hash,
you get a complete overview of all the operations included into the transaction.
- `AuditReader::getAudits()` now accepts a transaction hash as fifth parameter to return audits
logged in the given transaction for the given entity.
- `AuditReader::getAuditsByTransactionHash()` accepts a transaction hash as parameter and returns
all the audits logged in the given transaction.
* Better `SINGLE_TABLE` inheritance support (#73)
* Better single table (`SINGLE_TABLE`) inheritance support
- `AuditReader::getAudits()` now accepts a boolean as sixth parameter to return either audits
for the given entity only or audits for the given entity hierarchy.
* Performance enhancements when saving a lot of entities at once (closes #70, thanks to @acanicatti).
* Add class table (`JOINED`) inheritance support (thanks to @versh23)
* Performance enhancements when saving a lot of entities at once (thanks to @acanicatti).
* Removed deprecation messages (thanks to @maxhelias).
* Fixed an issue with `audit:schema:update` command when run against a database with no audit table (#85)
* Fixed an issue with `audit:schema:update` command when run against a database with no audit table
* A few icons have been added in the timeline.
* Revamped documentation

Expand Down
12 changes: 8 additions & 4 deletions doc/21-audit-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,9 +182,13 @@ dh_doctrine_audit:
```


## Single Table Inheritance
## Inheritance (Doctrine)

This bundle supports Doctrine [single table inheritance](https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/inheritance-mapping.html#single-table-inheritance).
This bundle supports all of Doctrine inheritance types:
- [mapped superclass inheritance](https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/inheritance-mapping.html#mapped-superclasses)
- [single table inheritance](https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/inheritance-mapping.html#single-table-inheritance)
- [class table inheritance](https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/inheritance-mapping.html#class-table-inheritance)

However, configuring the root table to be audited does not suffice to get all child tables audited.
You have to configure every child table that needs to be audited as well.

**Note**: configuring the root table to be audited does not suffice to get all child tables audited in a
**single table inheritance** context. You have to configure every child table that needs to be audited as well.

0 comments on commit b41c7af

Please sign in to comment.