README

Fork of DamienHarper/auditor-bundle with additional features for audit context, request tracking, snapshots, and admin integration.

Documentation

• Context & Metadata - Add notes, reasons, and request IDs to audits
• Querying Audits - Query audit entries with filters and timeline views
• Snapshots - Reconstruct entity state at any point in history
• Domain Events - Create EVENT-type audits for business actions
• Admin Integration - Browse audit logs in kachnitel/admin-bundle
• Configuration - Full configuration reference

For core auditing functionality, see the original documentation.

Features

Installation

composer require kachnitel/auditor-bundle

Quick Start

# config/packages/kachnitel_auditor.yaml
kachnitel_auditor:
    providers:
        doctrine:
            entities:
                App\Entity\Product: ~
                App\Entity\Order: ~

Once configured, any database change affecting audited entities is automatically logged to *_audit tables.

// Add context to audit entries
public function adjustStock(AuditContext $auditContext, Product $product): void
{
    $auditContext->set(['note' => 'Manual correction', 'reason' => 'inventory_count']);
    $product->setStock(95);
    $this->em->flush();
}

// Query audit history
$entries = $reader->findByEntityClass(Product::class, [$productId]);

// Get historical state
$historicalData = $snapshot->getPropertiesSnapshot($products, $date, ['stock', 'price']);

Requirements

• PHP >= 8.2
• Symfony >= 5.4
• Doctrine ORM >= 3.1

Migration

Migrating from damienharper/auditor-bundle? See MIGRATION.md.

License

MIT - see LICENSE