README

为CakePHP提供的日志插件。包含的AuditableBehavior为附加到模型的每个模型实例创建审计历史。

该行为在两个层面上跟踪更改。它在更改完成后对完全填充的对象进行快照，并在更新操作的情况下记录每个单独的更改。

特性

• 支持CakePHP 2.0。感谢@jasonsnider。
• 跟踪对象快照以及单个属性更改。
• 允许将每个修订记录附加到更改的责任来源——通常是用户。
• 允许开发者忽略指定属性的更改。默认情况下，名称为created、updated和modified的属性将被忽略，但这些值可以被重写。
• 处理HABTM关联的更改。
• 完全兼容PolymorphicBehavior。
• 不要求或依赖于显式模型修订（AuditLog）和差异（AuditLogDeltas）的存在。

安装

CakePHP >= 2.0

作为存档

1. 点击项目描述旁边的“下载”按钮。
2. 将存档解压到app/Plugin/AuditLog。

作为子模块

1. $ git submodule add git://github.com/robwilkerson/CakePHP-Audit-Log-Plugin.git <path_to>/app/Plugin/AuditLog
2. $ git submodule init
3. $ git submodule update

要创建表，可以使用模式外壳。要创建表，请执行以下命令

cd <path_to>/app/
chmod +x ./Console/cake
./Console/cake schema create -p AuditLog

CakePHP 1.3.x

对于与CakePHP 1.3.x一起使用，请确保使用1.3分支的代码，并遵循该README文件中的说明。

下一步

1. 在您的CakePHP应用程序数据库上运行install.sql文件。这将创建存储每个对象的更改历史的audits和audit_deltas表。

2. 如有需要，请创建一个currentUser()方法。

   AuditableBehavior可选地允许每个更改集由一个“来源”（通常是负责更改的用户）拥有。由于用户和身份验证模型差异很大，该行为支持一个回调方法，如果有的话，应返回要存储为更改来源的值。

   currentUser()方法必须对每个希望跟踪更改来源的模型都可用，因此我建议创建一个 CakePHP 的app_model.php文件的副本，并在其中添加该方法。保持DRY，对吧？

   如果核心Auth组件正在使用，存储更改集来源可能会有些棘手，因为用户数据在行为所在的模型层并不容易获得。一个选项是将这些数据从控制器转发。一种实现方式是在AppController::beforeFilter()中包含以下代码

    if( !empty( $this->data ) && empty( $this->data[$this->Auth->userModel] ) ) {
      $this->data[$this->Auth->userModel] = $this->currentUser();
    }
   

   该行为期望currentUser()方法返回一个包含id键的关联数组。从上面的例子继续，以下代码可能出现在AppModel中

    protected function currentUser() {
      $user = $this->Auth->user();
      
      return $user[$this->Auth->userModel]; # Return the complete user array
    }
   

3. 将行为附加到任何需要的模型并配置。

使用

将AuditableBehavior应用于模型基本上与将任何其他CakePHP行为应用于模型相同。行为确实提供了一些配置选项

`ignore`

一个属性名称数组，当在差异表中创建记录时将被忽略。

`habtm`

与活动模型具有HABTM关系的模型数组，其变化应与模型一起进行监控。如果HABTM模型本身是可审计的，请不要将其包含在内。此选项用于相关模型，这些模型的变更仅相对于活动模型进行跟踪。

语法

# Simple syntax accepting default options
class Task extends AppModel {
  public $actsAs = array( 'AuditLog.Auditable' );
      
  # 
  # Additional model code.
  #
}

# Syntax with explicit options
class Task extends AppModel {
  public $actsAs = array(
    'AuditLog.Auditable' => array(
      'ignore' => array( 'active', 'name', 'updated' ),
      'habtm'  => array( 'Type', 'Project' )
    )
  );
  
  # 
  # Additional model code.
  #
}

限制

• 主分支与CakePHP <=1.3.x版本不兼容。如果您需要与这些版本兼容，请从1.3分支安装代码，并遵循该README中的说明。

许可

此代码受MIT许可许可。

注意

请随时通过ticket提交错误报告或提出改进建议。您可以fork此项目并自行改进。欢迎贡献力量。