Installation
Install auditor using Composer
This guide covers the installation of the auditor library using Composer.
📋 Requirements
Version 4.x (Current)
| Requirement | Version |
|---|---|
| PHP | >= 8.4 |
| Symfony | >= 8.0 |
| Doctrine DBAL | >= 4.0 |
| Doctrine ORM | >= 3.2 |
Previous Versions
| Version | PHP | Symfony | Doctrine DBAL | Doctrine ORM |
|---|---|---|---|---|
| 3.x | >= 8.2 | >= 5.4 | >= 3.2 | >= 2.13 |
| 2.x | >= 7.4 | >= 4.4 | - | - |
| 1.x | >= 7.2 | >= 3.4 | - | - |
📦 Install via Composer
Open a terminal in your project directory and run:
composer require damienharper/auditor
This will install the latest stable version compatible with your PHP and dependency requirements.
Installing a Specific Version
To install a specific version:
# Install the latest 4.x version
composer require damienharper/auditor:^4.0
# Install the latest 3.x version
composer require damienharper/auditor:^3.0
🎵 Symfony Integration
For Symfony applications, we recommend using the auditor-bundle which provides:
- ✅ Automatic service configuration
- ✅ Web interface for browsing audits
- ✅ Console commands
- ✅ Twig extensions
composer require damienharper/auditor-bundle
TIP
See the auditor-bundle documentation for more details.
🔧 Standalone Usage
The library can be used without Symfony. You'll need to manually configure the Auditor and register providers.
See the Quick Start Guide for a complete setup example.
📚 Dependencies
The library automatically installs the following dependencies:
| Package | Purpose |
|---|---|
doctrine/dbal | Database abstraction layer |
doctrine/orm | Object-Relational Mapping |
symfony/event-dispatcher | Event handling |
symfony/options-resolver | Configuration handling |
symfony/cache | Metadata caching |
symfony/lock | Command locking |
Next Steps
- 🚀 Quick Start Guide - Set up auditing in your project
- ⚙️ Configuration - Configure auditor for your needs
- 🗄️ DoctrineProvider - Learn about the Doctrine provider