README

Database-backed AuditWriter for rasuvaeff/yii3-audit-log. Persists audit events to any yiisoft/db-compatible database (SQLite, MySQL, PostgreSQL, etc.).

Using an AI coding assistant? llms.txt has a compact API reference you can use.

Requirements

• PHP 8.3+
• rasuvaeff/yii3-audit-log ^1.0
• yiisoft/db ^2.0

Installation

composer require rasuvaeff/yii3-audit-log rasuvaeff/yii3-audit-log-db

Migration

Run the bundled migration to create the audit_log table:

// Register the migration in your migration runner:
// migrations/M260620000000CreateAuditLogTable.php
// from vendor/rasuvaeff/yii3-audit-log-db/migrations/

The migration creates:

Indexes: (subject_type, subject_id, occurred_at), (actor_type, actor_id, occurred_at), (occurred_at).

Yii3 config-plugin

Install rasuvaeff/yii3-audit-log (core) and rasuvaeff/yii3-audit-log-db (adapter). The adapter's config/di.php automatically binds AuditWriter to DbAuditWriter.

The core's config/di.php wires AuditLogger. You only need to bind ClockInterface in your application config:

// config/common/di/clock.php
use Psr\Clock\ClockInterface;

return [
    ClockInterface::class => MySystemClock::class,
];

Custom table name via params:

// config/common/params.php
return [
    'rasuvaeff/yii3-audit-log-db' => [
        'table' => 'my_audit_log',
    ],
];

Usage

Write via AuditLogger

use Rasuvaeff\Yii3AuditLog\AuditActor;
use Rasuvaeff\Yii3AuditLog\AuditChangeSet;
use Rasuvaeff\Yii3AuditLog\AuditLogger;
use Rasuvaeff\Yii3AuditLog\AuditSubject;

// Injected via DI:
/** @var AuditLogger $logger */

$logger->logChange(
    actor: AuditActor::user(id: (string) $user->id, name: $user->name),
    subject: AuditSubject::of(type: 'order', id: (string) $order->id),
    changes: AuditChangeSet::fromArrays(old: $before, new: $after),
);

Use directly

use Rasuvaeff\Yii3AuditLogDb\DbAuditWriter;

$writer = new DbAuditWriter(db: $db, table: 'audit_log');
$writer->write(event: $auditEvent);

Security

• DbAuditWriter validates the table name against /^[A-Za-z_]\w*(\.[A-Za-z_]\w*)?$/ — schema-qualified names like public.audit_log are allowed; arbitrary strings are rejected.
• All event field values are passed as bound parameters via yiisoft/db — no SQL injection risk.
• changes values are whatever AuditChangeSet contains. Apply SensitiveValueMasker in AuditLogger before this writer runs (default in core DI).

Examples

See examples/ for runnable scripts.

Development

# from monorepo root (/home/rasuvaeff/projects/rasuvaeff)
make -C yii3-audit-log-db install
make -C yii3-audit-log-db build
make -C yii3-audit-log-db cs-fix
make -C yii3-audit-log-db test

Or with Docker directly:

docker run --rm -v "$PWD":/repo -w /repo/yii3-audit-log-db composer:2 composer build

License

BSD-3-Clause. See LICENSE.md.