Modely a schéma

Balík stojí na štyroch modeloch. Každý používa soft deletes, má factory a dá sa vymeniť cez konfiguráciu:

Tabuľky

Stĺpce decision_scope a live zabezpečujú pravidlo jedného živého rozhodnutia na slot: unikátny index pokrýva schvaľovaný model, aktéra, decision_scope (žiadosť a stupeň, pri samostatnom rozhodnutí prázdne) a live, ktorý sa zmení na NULL, keď sa rozhodnutie stiahne, nahradí, vyprší alebo mäkko zmaže. JSON stĺpec approvers uchováva menovaných schvaľovateľov s váhou, ktorú mali pri otvorení — NULL, ak žiadosť či stupeň nikoho nevymenúva.

Relácie a scopes

• Approval — actor(), approvable(), decidedBy() a approvalRequest() (morph-to) a stage() (belongs-to). Scopes: pending(), approved(), rejected(), expired(), active() (čakajúce alebo schválené), live() (živé rozhodnutie každého slotu), inForce(?$moment) a expiringBefore($moment). Metódy: isInForce(?$moment) a wasDelegated().
• ApprovalRequest — subject() (morph-to), decisions() (morph-many) a stages() (has-many, zoradené podľa position). Metódy: namedApprovers(), approversFor(?$stage), hasNamedApprover($model), currentStage(), resolve(), isOverdue(?$moment), lapseIfOverdue(?$moment) a approvalProgress().
• ApprovalRequestStage — request() (belongs-to) a decisions() (has-many). Metódy: namedApprovers(), hasNamedApprover($model), isOpen() a markOpened().
• ApprovalDelegation — delegator() a delegate() (morph-to). Scopes active(?$moment) a inForceOrScheduled(?$moment); metódy isActiveAt(?$moment) a revoke(?$at).

use RoundlyConsulting\Approvals\Models\Approval;
use RoundlyConsulting\Approvals\Models\ApprovalDelegation;

Approval::query()->approved()->inForce()->whereMorphedTo('approvable', $post)->get();
Approval::query()->live()->whereMorphedTo('actor', $user)->get();   // each slot's live decision
Approval::query()->active()->expiringBefore(now())->get();

ApprovalDelegation::query()->active()->whereMorphedTo('delegate', $assistant)->get();
ApprovalDelegation::query()->inForceOrScheduled()->whereMorphedTo('delegator', $manager)->get();

Typ morph kľúča

key_type určuje typ siedmich polymorfných id stĺpcov — actor, approvable, approval_request a decided_by v approvals, subject v approval_requests a delegator a delegate v approval_delegations. Všetky morph ciele musia zdieľať jeden typ kľúča:

APPROVALS_KEY_TYPE=uuid   # bigint (default), uuid or ulid — set before you migrate

Nenastavená alebo prázdna hodnota sa číta ako bigint; akákoľvek iná vyhodí pri spustení migrácií InvalidConfigurationException, takže preklep nikdy potichu nevytvorí stĺpce bigint pre modely s UUID či ULID kľúčmi. Vlastné id balíka — vrátane approval_request_stage_id — sú vždy autoinkrementálne.

Výmena modelov

Ktorýkoľvek kľúč modelu nasmerujte na vlastnú podtriedu. Balík nakonfigurovanú triedu použije všade — v akciách, traitoch aj reláciách:

// config/approvals.php
'model' => App\Models\Approval::class,
'request_model' => App\Models\ApprovalRequest::class,
'stage_model' => App\Models\ApprovalRequestStage::class,
'delegation_model' => App\Models\ApprovalDelegation::class,

namespace App\Models;

use RoundlyConsulting\Approvals\Models\Approval as BaseApproval;

class Approval extends BaseApproval
{
    // your relations, scopes and casts
}

Trieda, ktorá nerozširuje očakávaný základný model, vyhodí InvalidApprovalModelException.