#PDF Templates

1
2
3
4
5
6
7
8
9
10
11

// config/signature.php
'templates' => [
    'dtr' => [
        'label'         => 'Daily Time Record',
        'view'          => 'pdf.dtr',  // your existing Blade
        'sample_data'   => ['user' => ['name' => 'Sample User']],
        'data_resolver' => fn ($record) => ['record' => $record],
        'slots'         => ['employee', 'in_charge'],
        'signable'      => \App\Models\Dtr::class,
    ],
],

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

// 1) Bare keys — label is the key in Title Case
'slots' => ['employee', 'in_charge'],

// 2) Keyed entries
'slots' => [
    'employee'  => ['label' => 'Employee', 'required' => true],
    'in_charge' => ['label' => 'In Charge', 'required' => true],
],

// 3) List of entries with a 'key' field
'slots' => [
    ['key' => 'employee',  'label' => 'Employee',  'required' => true],
    ['key' => 'in_charge', 'label' => 'In Charge', 'required' => true],
],

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

// app/Pdf/BrowsershotRenderer.php
use Kukux\DigitalSignature\Pdf\Renderers\PdfRenderer;

class BrowsershotRenderer implements PdfRenderer
{
    public function render(string $view, array $data, string $destinationPath): string
    {
        \Spatie\LaravelPdf\Facades\Pdf::view($view, $data)->save($destinationPath);
        return $destinationPath;
    }

    public static function isAvailable(): bool
    {
        return class_exists(\Spatie\LaravelPdf\Facades\Pdf::class);
    }
}

// config/signature.php
'templates' => [
    'dtr' => [
        'view'     => 'pdf.dtr',
        'renderer' => \App\Pdf\BrowsershotRenderer::class,
        // …
    ],
],

1
2
3
4
5
6
7
8

// a template class
use Kukux\DigitalSignature\Pdf\Renderers\DomPdfRenderer;

parent::__construct(
    key: 'dtr',
    // …
    renderer: new DomPdfRenderer(paper: 'legal'),          // or paper: 'a4', orientation: 'landscape'
);

1
2
3
4
5
6
7
8

// or a config-array template
'templates' => [
    'dtr' => [
        'view'  => 'pdf.dtr',
        'paper' => 'legal',
        // 'orientation' => 'landscape',
    ],
],

1
2
3
4
5

$pdf = \Barryvdh\DomPDF\Facade\Pdf::loadView($view, $data)->setPaper('a4');

$anchors = \Kukux\DigitalSignature\Pdf\SlotAnchors::record($pdf->getDomPDF());
file_put_contents($destinationPath, $pdf->output());
\Kukux\DigitalSignature\Pdf\SlotAnchors::write($destinationPath, $anchors());

1
2
3

<p>Prepared By:</p>
<div data-signature-slot="prepared_by" style="height: 56px"></div>
<p class="signature-line">{{ $preparer->name }}</p>

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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

namespace App\Pdf;

use App\Models\Dtr;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\Storage;
use Kukux\DigitalSignature\Contracts\PdfTemplate;
use Kukux\DigitalSignature\Pdf\SlotDefinition;

class DtrTemplate implements PdfTemplate
{
    // Stored as template_key. Don't change it once rows exist.
    public function key(): string
    {
        return 'dtr';
    }

    public function label(): string
    {
        return 'Daily Time Record';
    }

    public function slots(): array
    {
        return [
            new SlotDefinition(
                key:           'employee',
                label:         'Employee',
                defaultPage:   1,
                defaultX:      135,
                defaultY:      90,
                defaultWidth:  200,
                defaultHeight: 40,
                required:      true,
            ),
            new SlotDefinition(
                key:           'in_charge',
                label:         'In Charge',
                defaultPage:   1,
                defaultX:      520,
                defaultY:      90,
                defaultWidth:  200,
                defaultHeight: 40,
                required:      true,
            ),
        ];
    }

    // Designer preview. Keep it deterministic so page images cache.
    public function renderSample(): string
    {
        $disk = Storage::disk(config('signature.storage_disk'));
        $rel  = 'samples/dtr.pdf';

        if (! $disk->exists($rel)) {
            $disk->put($rel, app(DtrPdfRenderer::class)->renderBinarySample());
        }

        return $disk->path($rel);
    }

    // The real PDF for one record, at sign time.
    public function renderFor(Model $record): string
    {
        assert($record instanceof Dtr);

        $disk = Storage::disk(config('signature.storage_disk'));

        // Keyed on updated_at too, so an edited record isn't served a stale render.
        $rel  = "generated/dtr/{$record->getKey()}-{$record->updated_at?->timestamp}.pdf";

        if (! $disk->exists($rel)) {
            $disk->put($rel, app(DtrPdfRenderer::class)->renderBinary($record));
        }

        return $disk->path($rel);
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

// 1. config/signature.php — every panel and the CLI
'templates' => [
    'dtr' => ['view' => 'pdf.dtr', 'slots' => ['employee', 'in_charge']],
    \App\Pdf\PayslipTemplate::class,
],

// 2. A Filament panel — when panels should see different templates
\Kukux\DigitalSignature\SignaturePlugin::make()
    ->templates([
        'dtr' => ['view' => 'pdf.dtr', 'slots' => ['employee', 'in_charge']],
        \App\Pdf\PayslipTemplate::class,
    ]),

// 3. Any service provider's boot()
$registry = app(\Kukux\DigitalSignature\Services\PdfTemplateRegistry::class);
$registry->registerBlade('dtr', ['view' => 'pdf.dtr', 'slots' => ['employee', 'in_charge']]);
$registry->register(\App\Pdf\PayslipTemplate::class);
// or $registry->registerMany([...]) with the same mixed list as config

1
2
3
4

$registry->has('dtr');   // bool
$registry->find('dtr');  // ?PdfTemplate — use for user input
$registry->get('dtr');   // PdfTemplate, throws RuntimeException if missing
$registry->all();        // array<string, PdfTemplate>

1
2
3
4
5
6
7

use Filament\Actions\Action;
use Kukux\DigitalSignature\Filament\Pages\PdfTemplateDesigner;

Action::make('design_layout')
    ->label('Design layout')
    ->icon('heroicon-o-rectangle-group')
    ->url(fn () => PdfTemplateDesigner::getUrl(['templateKey' => 'dtr']));

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

use Kukux\DigitalSignature\Contracts\PdfTemplate;
use Kukux\DigitalSignature\Contracts\RendersSamplePageImage;

class DtrTemplate implements PdfTemplate, RendersSamplePageImage
{
    // ... existing PdfTemplate methods ...

    public function renderSampleAsImage(int $page): string
    {
        // Absolute path to a PNG/JPEG of $page (1-indexed).
        return app(DtrPdfRenderer::class)->renderPageAsPng(page: $page);
    }

    public function sampleImagePageCount(): int
    {
        return 1;
    }
}

1
2
3
4

// config/signature.php
'designer' => [
    'dpi' => env('SIGNATURE_DESIGNER_DPI', 144),
],

1
2
3
4
5
6

use Kukux\DigitalSignature\Models\PdfTemplateSlot;

PdfTemplateSlot::updateOrCreate(
    ['template_key' => 'dtr', 'slot_key' => 'employee'],
    ['page' => 1, 'x' => 135, 'y' => 90, 'width' => 200, 'height' => 40],
);

1

/<panel-path>/signature-templates/{templateKey}/sign/{signatureUuid}

1
2
3
4
5
6
7
8
9
10

use Illuminate\Database\Eloquent\Model;
use Kukux\DigitalSignature\Concerns\HasPdfTemplate;
use Kukux\DigitalSignature\Contracts\Signable;

class Dtr extends Model implements Signable
{
    use HasPdfTemplate;

    protected string $signaturePdfTemplate = 'dtr';   // matches the template key
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

use Filament\Actions\Action;
use Kukux\DigitalSignature\Filament\Pages\PdfTemplateSigner;
use Kukux\DigitalSignature\Models\Signature;

Action::make('sign_with_my_signature')
    ->label('Sign')
    ->icon('heroicon-o-pencil-square')
    ->url(function ($record) {
        $signature = Signature::query()
            ->where('user_id', auth()->id())
            ->whereNull('signable_id')
            ->where('status', 'active')
            ->latest('id')
            ->firstOrFail();

        return PdfTemplateSigner::getUrl([
            'templateKey'   => 'dtr',
            'signatureUuid' => $signature->uuid,
        ]).'?signable='.$record->getKey();
    });