Laravel Sign Pad

When implementing ShouldGenerateSignatureDocument, use getSignatureDocumentTemplate() to return a SignatureDocumentTemplate.

Key configuration options:

• outputPdfPrefix: (optional) Prefix for the generated PDF filename.
• template: An instance of BladeDocumentTemplate or PdfDocumentTemplate.
• signaturePositions: An array of SignaturePosition objects defining where the signature appears on specific pages.

Note: A $model object is automatically injected into Blade templates, allowing access to model properties.

public function getSignatureDocumentTemplate(): SignatureDocumentTemplate
{
    return new SignatureDocumentTemplate(
        outputPdfPrefix: 'document',
        signaturePositions: [
             new SignaturePosition(
                 signaturePage: 1,
                 signatureX: 20,
                 signatureY: 25,
             ),
        ]
    );
}

To enable signing on a model, add the RequiresSignature trait and implement the CanBeSigned contract.

If you want to generate PDF documents containing the signature, you must also implement the ShouldGenerateSignatureDocument contract and define the getSignatureDocumentTemplate() method using a SignatureDocumentTemplate object.

<?php

namespace App\Models;

use Creagia\LaravelSignPad\Concerns\RequiresSignature;
use Creagia\LaravelSignPad\Contracts\CanBeSigned;
use Creagia\LaravelSignPad\Contracts\ShouldGenerateSignatureDocument;
use Creagia\LaravelSignPad\Templates\BladeDocumentTemplate;
use Creagia\LaravelSignPad\SignatureDocumentTemplate;
use Creagia\LaravelSignPad\SignaturePosition;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model implements CanBeSigned, ShouldGenerateSignatureDocument
{
    use RequiresSignature;
    
    public function getSignatureDocumentTemplate(): SignatureDocumentTemplate
    {
        return new SignatureDocumentTemplate(
            outputPdfPrefix: 'document',
            signaturePositions: [
                 new SignaturePosition(
                     signaturePage: 1,
                     signatureX: 20,
                     signatureY: 25,
                 ),
                 new SignaturePosition(
                     signaturePage: 2,
                     signatureX: 25,
                     signatureY: 50,
                 ),
            ]
        );
    }
}

When upgrading from version 1.x to 2.x, you must perform the following steps to ensure compatibility with new asset structures, configuration keys, and template logic:

1. Refresh Javascript Assets: Delete existing assets in public/vendor/sign-pad and re-publish them using the artisan command.
2. Update Configuration: The configuration key store_path has been renamed to signatures_path. You must also add the disk_name and documents_path keys.
3. Update Signature Templates: The SignatureDocumentTemplate constructor no longer accepts individual coordinate parameters. Instead, it requires a signaturePositions array containing SignaturePosition objects. This allows for multiple signature locations on a single document.

### 1. Refresh Assets
```bash
rm -rf public/vendor/sign-pad
php artisan vendor:publish --tag=sign-pad-assets

2. Update Config

// config/sign-pad.php
'disk_name' => env('SIGNATURES_DISK', 'local'),
'signatures_path' => 'signatures',
'documents_path' => 'signed_documents',

3. Update Template Logic

use Creagia\LaravelSignPad\Templates\PdfDocumentTemplate;
use Creagia\LaravelSignPad\SignatureDocumentTemplate;
use Creagia\LaravelSignPad\SignaturePosition;

public function getSignatureDocumentTemplate(): SignatureDocumentTemplate
{
    return new SignatureDocumentTemplate(
        outputPdfPrefix: 'document', // optional
        template: new PdfDocumentTemplate(storage_path('pdf/template.pdf')),
        signaturePositions: [
             new SignaturePosition(
                 signaturePage: 1,
                 signatureX: 20,
                 signatureY: 25,
             ),
             new SignaturePosition(
                 signaturePage: 2,
                 signatureX: 25,
                 signatureY: 50,
             ),
        ]               
    );
}

The Signature model represents a recorded signature and provides methods to retrieve the paths for both the signature image and the signed document. These paths are resolved using the sign-pad.disk_name, sign-pad.signatures_path, and sign-pad.documents_path configuration settings.

Signature Image Paths

• getSignatureImagePath(): Returns the relative path to the signature image file.
• getSignatureImageAbsolutePath(): Returns the absolute system path to the signature image file.

Signed Document Paths

If a document has been signed (i.e., document_filename is not null), you can retrieve:

• getSignedDocumentPath(): Returns the relative path to the signed document.
• getSignedDocumentAbsolutePath(): Returns the absolute system path to the signed document.

// Assuming $signature is an instance of Creagia\LaravelSignPad\Signature

// Get relative paths
$imagePath = $signature->getSignatureImagePath();
$docPath = $signature->getSignedDocumentPath();

// Get absolute system paths
$imageAbsPath = $signature->getSignatureImageAbsolutePath();
$docAbsPath = $signature->getSignedDocumentAbsolutePath();