Download the PHP package zhortein/auditable-bundle without Composer
On this page you can find all versions of the php package zhortein/auditable-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package auditable-bundle
Zhortein Auditable Bundle
Zhortein Auditable Bundle provides two audit paths for Symfony applications using Doctrine ORM:
- the compatibility-preserved legacy listener, which records selected entity changes automatically;
- an opt-in strict recorder that lets the application own its audit model, persistence and transaction boundary.
Requirements
- PHP 8.3 or later
- Symfony 7.4 or 8.x
- Doctrine ORM 3.x
- DoctrineBundle 2.19 or 3.x
Symfony Messenger is a required package dependency and supports the legacy asynchronous writer. The bundle includes symfony/polyfill-mbstring; the native mbstring extension remains recommended for performance.
See the 2.0 upgrade guide before upgrading an existing application.
Installation
Without Symfony Flex recipes, enable the bundle in config/bundles.php:
With no bundle configuration, the legacy runtime and its AuditEntry mapping remain enabled and the transactional recorder remains disabled. The bundle does not apply migrations automatically. Review any Doctrine migration generated for your application before running it.
Choose an audit path
The legacy mode preserves the 1.0 behavior for existing applications. It is convenient for automatic create, update and delete histories, but is fail-open, flushes through its persister and does not guarantee atomicity with the business write.
The transactional Doctrine integration is opt-in. It is intended for operations where an audit failure must prevent the business commit. The application supplies its own audit entity, factory, storage and clock; the bundle supplies no default persistence model for this path.
Both paths can coexist during a migration. The 2.0 upgrade guide covers coexistence, transactional-only applications and rollback planning.
Legacy quick start
Mark an entity with the actual legacy attributes:
The defaults are:
When async.enabled is true, route Zhortein\AuditableBundle\Message\PersistAuditEntryMessage through Symfony Messenger. The historical async.transport key is preserved for compatibility; Messenger routing determines the effective transport. Set async.enabled: false to use the synchronous legacy writer.
The complete options and historical limitations are documented in Legacy mode. A commented example is available at config/packages/zhortein_auditable.yaml.example.
Transactional quick start
Enable the recorder explicitly:
Provide application services through standard Symfony aliases:
The bundle provides default aliases for IdentifierExtractorInterface and AuditActorResolverInterface; the application may replace either alias. It intentionally provides no entry factory, storage or clock.
Keep the mutation and audit entry in the same application-owned Unit of Work:
The strict recorder performs no flush, commit or rollback and does not catch factory or storage exceptions. Fail-closed behavior therefore requires the audit storage to use the same entity manager and connection and not to flush independently. The application controls the transaction boundary.
No Doctrine audit entity, storage or migration is imposed by the bundle. The executable PostgreSQL proof and full boundary rules are in the transactional Doctrine guide.
Transactional-only applications
After all legacy producers, pending Messenger messages and legacy workers have been dealt with, an application may omit the legacy mapping:
enabled controls the legacy runtime, legacy_mapping.enabled controls only Doctrine registration of the legacy AuditEntry, and transactional.enabled controls the strict recorder. Their defaults are true, true and false. Disabling the mapping while legacy auditing remains enabled is rejected.
This option never drops an existing audit_entry table and supplies no migration. See the upgrade guide before opting out.
Security and non-guarantees
Never audit passwords, tokens, private keys or other secrets. Use #[AuditIgnore], fields.global_ignored and application-level factory/storage validation to minimize recorded data. Actor identifiers and audit payloads may be personal data.
The bundle does not provide encryption at rest, cryptographic signatures, hash chaining, append-only storage, retention, purge, anonymization or legal compliance. Strict transactional recording provides a fail-closed transaction boundary when integrated correctly; it does not provide tamper evidence. See Security and privacy.
Documentation
- Documentation index
- Legacy mode
- Transactional Doctrine integration
- Upgrade from 1.0 to 2.0
- Security and privacy
- Compatibility and deprecation
- Changelog
License
MIT. See LICENSE.
All versions of auditable-bundle with dependencies
psr/clock Version ^1.0
psr/log Version ^3.0
doctrine/doctrine-bundle Version ^2.19 || ^3.0
doctrine/orm Version ^3.0
symfony/config Version ^7.4 || ^8.0
symfony/dependency-injection Version ^7.4 || ^8.0
symfony/framework-bundle Version ^7.4 || ^8.0
symfony/http-kernel Version ^7.4 || ^8.0
symfony/messenger Version ^7.4 || ^8.0
symfony/options-resolver Version ^7.4 || ^8.0
symfony/polyfill-mbstring Version ^1.33
symfony/security-bundle Version ^7.4 || ^8.0