Getting Started

← Home

On the gated model

Apply RequiresApprovalWhenChanges to the model whose changes should go through the workflow, and implement Approvable:

use ReynoTECH\Approvals\Concerns\RequiresApprovalWhenChanges;
use ReynoTECH\Approvals\Contracts\Approvable;

class Client extends Model implements Approvable
{
    use RequiresApprovalWhenChanges;

    // Optional, both default to 1. Don't redeclare the trait's $approversRequired property
    // with another value on this class: PHP treats that as a fatal composition error.
    protected function approversRequired(): int
    {
        return 2;
    }

    // Decide when a change needs approval instead of saving directly.
    protected function requiresApprovalWhenTrait(array $dirty): bool
    {
        return array_key_exists('billing_address', $dirty);
    }
}

On the approver model

Apply ApprovesChanges to the model that casts approvals/disapprovals (e.g. User), and implement Approver:

use ReynoTECH\Approvals\Concerns\ApprovesChanges;
use ReynoTECH\Approvals\Contracts\Approver;

class User extends Authenticatable implements Approver
{
    use ApprovesChanges;
}

Basic flow

$client->billing_address = $newAddress;
$client->save(); // captured as a pending Modification instead of persisted

$modification = $client->modifications()->activeOnly()->first();

$user->approve($modification, 'confirmed with client');
// once approvers_required is reached, the diff is applied and the row is updated

A held change doesn’t stay on the instance: after that save(), $client->billing_address is the stored value again, and the proposed one is in $client->getLastModification().

An update that does not require approval is saved directly, and a full audit Modification (flow: direct, status: applied) is still recorded — no approval rows are created for it.

Next: Modification & History.