API-Skeletons/zf-doctrine-audit

This repository creates an auditing database to track your target database changes.

Auditing is a complex subject. I’ve spent years trying to find an easier answer and by leveraging Object Relational Mapping through Doctrine what we have here is a plugin for new or existing Doctrine Zend Framework projects to implement auditing across a selection of entities or the whole database.

Table of Contents

• Quickstart
• Getting Started
  • Installation
    • zf-component-installer
  • Configuration
    • target_object_manager
    • audit_object_manager
    • audit_table_name_prefix & audit_table_name_suffix
    • epoch_import_limit
    • entities
    • joinEntities
  • Audit Object Manager
• Create Audit Database & Triggers
  • Create Database
  • Run Fixtures
  • Run Triggers
  • Drop Triggers
  • Auditing is Working
• Epoch
• How Auditing Works
  • AuditEntity
  • RevisionEntity Entity
  • Revision Entity
• Audit Plugin
  • getRevisionEntityCollection($entity)
  • getOldestRevisionEntity($entity)
  • getNewestRevisionEntity($entity)
• Revision Comment
  • Fetching RevisionComment
  • Using RevisionComment
  • Custom Identity for Revision Auditing
• Change Management
  • Adding a new field or audited entity
    • Update the audit database with the new field
    • Update the audit database fixtures
    • Update the target database triggers
  • Removing a field from an entity
• Unit Testing
• Internals
  • Audit Entity Autoloader
  • Audit Object Manager Metadata
  • Trigger Tool
    • get_revision_entity_audit function
    • close_revision_audit function
    • create, update, delete triggers
  • Epoch Tool
  • RevisionAudit Tool