tatter/审计

CodeIgniter 4 的轻量级对象日志

v1.1.3 2022-06-21 21:04 UTC

README

CodeIgniter 4 的轻量级对象日志

Coverage Status

快速入门

  1. 使用 Composer 安装: > composer require tatter/audits
  2. 更新数据库: > php spark migrate --all
  3. 设置模型
use Tatter\Audits\Traits\AuditsTrait;

class JobModel extends Model
{
	use AuditsTrait;
	protected $afterInsert = ['auditInsert'];
	protected $afterUpdate = ['auditUpdate'];
	protected $afterDelete = ['auditDelete'];

功能

为 CodeIgniter 4 提供现成的对象日志

安装

通过 Composer 安装以利用 CodeIgniter 4 的自动加载功能,并始终保持最新状态

> composer require tatter/audits

或者,手动安装,下载源代码并将目录添加到 app/Config/Autoload.php

一旦文件下载并包含在自动加载中,运行任何库迁移以确保数据库设置正确

> php spark migrate --all

配置(可选)

可以通过扩展其配置文件来更改库的默认行为。将 examples/Audits.php 复制到 app/Config/Audits.php 并遵循注释中的说明。如果 app/Config 中没有找到配置文件,库将使用自己的。

用法

一旦包含库,所有资源就准备就绪,您只需指定要审计的模型和事件。使用 AuditsTrait 为您希望跟踪的任何模型添加支持

use Tatter\Audits\Traits\AuditsTrait;

class JobModel extends Model
{
	use AuditsTrait;

然后指定您想要审计的事件,通过为这些事件分配相应的审计方法

	protected $afterInsert = ['auditInsert'];
	protected $afterUpdate = ['auditUpdate'];
	protected $afterDelete = ['auditDelete'];

Audits 库将在 audits 表中创建每个事件的简单日志,例如

| id | source | source_id | user_id | event  | summary  |          created_at |
+----+--------+-----------+---------+--------+----------+---------------------+
| 10 | sites  |        27 |       9 | create | 2 rows   | 2019-04-05 15:58:40 |
| 11 | jobs   |        10 |       9 | update | 5 rows   | 2019-04-05 16:01:35 |