Attribute Modifiers #

Version 8.0.0 brings the AttributeModifier contract, improving the way Auditable attributes can be modified, when creating an Audit.

Attribute Redactors #

Attribute Redactors (previously called Audit Redactors) were introduced in version 6.1.0, making it easy to mask sensitive information when auditing.

Two redactors are included, out of the box.

LeftRedactor #

The LeftRedactor will mask part of the data, from the left.

RightRedactor #

The RightRedactor will work in the same fashion as the previous one, but like the name implies, it will mask the data from the right.

Custom redactors #

If the two default redactors don't suit your needs, you're free to implement your own.

A redactor is a class that implements the \OwenIt\Auditing\Contracts\AttributeRedactor interface.

Usage #

<?php
namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use OwenIt\Auditing\Contracts\Auditable;
use OwenIt\Auditing\Redactors\LeftRedactor;

class Article extends Model implements Auditable
{
    use \OwenIt\Auditing\Auditable;

    /**
     * Attribute modifiers.
     *
     * @var array
     */
    protected $attributeModifiers = [
        'title' => LeftRedactor::class,
    ];

    // ...
}

Attribute Encoders #

The AttributeEncoder interface was introduced in version 8.0.0. By default, one encoder is included.

Base64Encoder #

As the name implies, the Base64Encoder will encode attributes in Base64.

Custom encoders #

In the same fashion as a custom AttributeRedactor, feel free to create your own AttributeEncoder implementations.

Just create a class implementing the \OwenIt\Auditing\Contracts\AttributeEncoder interface.

Usage #

<?php
namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use OwenIt\Auditing\Contracts\Auditable;
use OwenIt\Auditing\Encoders\Base64Encoder;

class Article extends Model implements Auditable
{
    use \OwenIt\Auditing\Auditable;

    /**
     * Attribute modifiers.
     *
     * @var array
     */
    protected $attributeModifiers = [
        'title' => Base64Encoder::class,
    ];

    // ...
}