#Signable documents

1
2
3
4
5
6
7
8
9
10
11

namespace App\Signatures;

use Kukux\DigitalSignature\Documents\AbstractSignableDocument;

class TravelRequestDocument extends AbstractSignableDocument
{
    public function template(): string
    {
        return 'travel-request';
    }
}

1
2
3
4

// config/signature.php
'documents' => [
    'travel-request' => \App\Signatures\TravelRequestDocument::class,
],

1
2
3

use Kukux\DigitalSignature\Filament\Actions\RouteForSignaturesAction;

RouteForSignaturesAction::make()->document('travel-request')

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

use App\Models\Dtr;
use Kukux\DigitalSignature\Documents\AbstractSignableDocument;

class DtrDocument extends AbstractSignableDocument
{
    public function __construct(private SupervisorSignatoryDefaults $defaults) {}

    public function template(): string
    {
        return 'dtr';
    }

    public function locate(mixed $employee, array $context = []): ?Model
    {
        return Dtr::firstWhere(['employee_id' => $employee->id, 'month' => $context['month']]);
    }

    public function open(mixed $employee, array $context = []): Model
    {
        $dtr = $this->locate($employee, $context)
            ?? new Dtr(['employee_id' => $employee->id, 'month' => $context['month']]);

        $dtr->snapshotSignatories($this->defaults);
        $dtr->save();

        return $dtr;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

use Kukux\DigitalSignature\Contracts\PreflightGuard;
use Kukux\DigitalSignature\Routing\RoutingResult;

final class HasTimeLogs implements PreflightGuard
{
    public function __construct(private TimeLogRepository $logs) {}

    public function check(mixed $employee, array $context): ?RoutingResult
    {
        return $this->logs->countFor($employee, $context['month']) === 0
            ? RoutingResult::refused('no_time_logs')
            : null;
    }
}

1
2
3
4
5
6
7
8

$result = app(DocumentRouter::class)->route('dtr', $employee, ['month' => '2026-09']);

$result->ok();          // routed or already routed
$result->reason();      // 'routed', 'already_routed', 'missing_signatories', 'markers_missing', 'not_ready', or a guard's code
$result->title();       // "Routed for signatures"
$result->body();        // "Sent to Juana Cruz and Dr Reyes. They'll sign in that order."
$result->record();      // the routed record
$result->session();     // the signing session

1
2
3
4
5
6
7

public function messages(): array
{
    return [
        'no_time_logs'        => ['title' => 'Nothing to file', 'body' => 'No time logs for this month yet.'],
        'missing_signatories' => ['body' => 'Set your :roles under "My signatories" first.'],
    ];
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

use Kukux\DigitalSignature\Traits\SnapshotsSignatories;

class Dtr extends Model implements Signable
{
    use HasPdfTemplate, HasSignatories, SnapshotsSignatories;

    protected string $signaturePdfTemplate = 'dtr';

    public function signatoryRoles(): array { return ['in_charge']; }

    public function signatoryModel(): string { return Employee::class; }

    public function inCharge(): BelongsTo { return $this->signatoryRelation('in_charge'); }
}

1
2
3
4
5

// the migration
use Kukux\DigitalSignature\Database\SignatoryColumns;

SignatoryColumns::add($table, ['in_charge'], references: 'employees');
// in_charge_signatory_id (nullable, null on delete), in_charge_position

1
2
3
4
5
6
7
8
9
10
11
12

use Kukux\DigitalSignature\Contracts\SignatoryDefaults;
use Kukux\DigitalSignature\Signatories\SignatoryAssignment;

final class SupervisorSignatoryDefaults implements SignatoryDefaults
{
    public function for(Model $record, string $role): ?SignatoryAssignment
    {
        $supervisor = $record->employee?->supervisor;

        return $supervisor ? new SignatoryAssignment($supervisor->id, $supervisor->position_title) : null;
    }
}