Download the PHP package proai/laravel-data-integrity without Composer

Laravel Data Integrity

Scan your Eloquent models for data integrity violations and fix them automatically.

Concept

An audit case is a class that groups one or more integrity checks for a given model. Each check* method defines a single audit that examines every record in chunks and reports violations. Audit cases are discovered automatically from database/audits/, and violations can be fixed in place when passed --fix.

Installation

The package auto-registers itself via Laravel's package discovery. The db:audit command is available immediately after installation.

Since audits live in database/audits/ by default, you need to register the namespace in your application's composer.json so the classes can be autoloaded:

Then run composer dump-autoload.

Usage

Creating an audit case

Create a class anywhere under database/audits/ extending ProAI\DataIntegrity\AuditCase. It will be discovered automatically. Each public check* method defines one audit and returns an Audit.

Inline audits

Define checks as individual methods using the fluent builder:

The validate closure receives a single model instance and a $fail closure. Call $fail(string $reason) to report a violation. The model identifier (e.g. Order #42:) is automatically prepended to the reason in the output.

To support --fix, pass an optional fix closure as the second argument to $fail:

The fluent builder supports query(), chunkSize(), before(), and after():

Description from method name

When no description is passed to audit(), it is derived from the method name automatically:

Lifecycle hooks: before and after

Use before and after to run logic before and after each chunk is validated. The before hook is useful for preloading related data or setting up shared state, while after can be used for cleanup or post-processing:

Reusable checks with IntegrityCheck

For checks that are shared across multiple audits, create a class implementing IntegrityCheck:

Then reference it in your audit case with auditUsing():

Check classes can accept constructor arguments, making them reusable across different models and relationships. The example above shows how BelongsToExists can verify any belongsTo relationship — just pass the relation name.

For counter cache validation, a generic check class avoids duplicating the same logic:

Check classes can also define optional before($chunk), after($chunk), query(), and description() methods. Use before to batch-load data per chunk instead of querying per model:

Registering check aliases

You can register short aliases for check classes and reference them by name:

Configuration

All global settings are managed through the AuditManager class. Configure them in a service provider:

Individual audits can still override the chunk size per check via the chunkSize() method.

API

AuditManager

AuditCase (abstract base class)

Audit (fluent builder)

IntegrityCheck (interface)

Optionally add before(EloquentCollection $chunk): void, after(EloquentCollection $chunk): void, query(): Closure, and/or description(): string methods.

$fail closure

License

MIT