EntityAuditBundle 技术文档

1. 安装指南

EntityAuditBundle 是一个为 Doctrine 2 提供实体和其关联完整版本功能的扩展。以下是安装步骤：

安装扩展

假设您已经安装了 Composer，运行以下命令：

$ composer require sonata-project/entity-audit-bundle

启用扩展

在您的应用内核中启用扩展：

// config/bundles.php

return [
    //...
    SimpleThings\EntityAudit\SimpleThingsEntityAuditBundle::class => ['all' => true],
    //...
];

配置

加载 "simple_things_entity_audit" 扩展并指定审计实体：

# config/packages/entity_audit.yaml

simple_things_entity_audit:
    audited_entities:
        - MyBundle\Entity\MyEntity
        - MyBundle\Entity\MyEntity2

如果您需要排除某些实体属性以避免触发修订，使用以下配置：

# config/packages/entity_audit.yaml

simple_things_entity_audit:
    global_ignore_columns:
        - created_at
        - updated_at

若要使用除 "default" 之外的连接或实体管理器，使用以下设置：

# config/packages/entity_audit.yaml

simple_things_entity_audit:
    connection: custom
    entity_manager: custom

如果需要显式禁用从审计实体推断的外键，使用以下参数：

simple_things_entity_audit:
    disable_foreign_keys: true

创建新表

运行以下命令查看更新模式队列中的新表：

./bin/console doctrine:schema:update --dump-sql

2. 项目的使用说明

EntityAuditBundle 可以自动为实体和其关联创建版本。它通过在数据库中为每个审计实体创建一个后缀为 "_audit" 的镜像表来实现。除了审计实体的所有列之外，还有两个字段：

• rev：包含从 "revisions" 表生成的全局修订号。
• revtype：包含 'INS'、'UPD' 或 'DEL' 作为指示哪种数据库操作导致了修订日志条目的信息。

全局修订表包含一个 ID、时间戳、用户名和更改评论字段。

使用这种方法可以实现对应用程序及其在特定时间点的关联更改的版本控制。

此扩展会钩入 SchemaTool 生成过程，以便自动为您的审计实体创建所需的 DDL 语句。

3. 项目API使用文档

以下是 EntityAuditBundle 提供的一些主要 API 方法：

• find($className, $id, $rev)：查找给定修订号下的实体状态。
• findRevisions($className, $id)：查找实体的修订历史。
• findEntitiesChangedAtRevision($rev)：查找在特定修订中更改的实体。
• getCurrentRevision($className, $id)：查找实体的当前修订号。

4. 项目安装方式

EntityAuditBundle 可以通过以下方式安装：

• Composer：使用 composer require sonata-project/entity-audit-bundle 命令安装。
• Standalone：对于独立使用，您需要将实体类名传递给 MetadataFactory 实例并配置两个事件监听器。具体请参考项目文档中的 "Installation (Standalone)" 部分。

以上是 EntityAuditBundle 的技术文档概览，希望对您有所帮助。