Download the PHP package mrnewport/laravel-docsign without Composer

Laravel Document Generation & E-Signatures (mrnewport/laravel-docsign)

A config-driven, expandable package for document generation (multiple PDF and template engines) and e-signatures (multiple providers). Ideal for any use case—from real estate lease agreements, NDAs, or HR forms, to finance, legal, and more.

Table of Contents

• Features
• Requirements
• Installation
• Configuration
  • PDF Renderer
  • Template Engine
  • Signature Providers
  • Storage Disk
• Usage
  • Creating a Document
  • Generating a PDF
  • Requesting E-Signatures
  • Handling Callbacks
  • Example Multi-Signer Flow
• Advanced & Unusual Use Cases
  • Versioning Documents
  • Security & Encryption
  • Docker Environments
  • Notifications & Webhooks
• Expandability
  • Custom PDF Engines
  • Custom Template Engines
  • Custom Signature Providers
• Testing
• License

Features

1. Multi-Engine PDFs: DomPDF or wkhtmltopdf (plus custom).
2. Multi-Engine Templates: Blade or Twig (plus custom).
3. Pluggable E-Sign: Local (demo), DocuSign, HelloSign.
4. Config-Driven: Swap engines and providers in docsign.php without editing package code.
5. Storage Disk support for PDF files.
6. Facade-based usage: DocSign::generate(...), DocSign::requestSignature(...), etc.

Requirements

• PHP >=8.1
• Laravel ^11.0
• If using wkhtmltopdf, install the binary on your server/CI environment.

Installation

1. Require the package:

2. Publish config (optional):

3. Migrate:

Done—you can now generate docs, request signatures, handle callbacks.

Configuration

All config is in src/config/docsign.php (published to config/docsign.php if you run the above publish command). No direct package edits required—just tweak config to your needs.

PDF Renderer

• 'dompdf' uses a pure-PHP library.
• 'wkhtml' uses wkhtmltopdf (system binary).
• For custom, see Custom PDF Engines.

Template Engine

• 'blade' integrates standard Laravel Blade.
• 'twig' uses Twig.
• For your own engine, see Custom Template Engines.

Signature Providers

• 'local' is a demo.
• 'docusign', 'hellosign' are stubs for real external e-sign flows.
• Provide 'api_key' or 'callback_url' as needed.

Storage Disk

Defines which disk (from config/filesystems.php) to store final PDFs. E.g., 's3' or 'local'.

Usage

Creating a Document

• title is used for naming the PDF.
• data merges into the template, storing placeholders like 'partyA'.

Generating a PDF

Requesting E-Signatures

You might redirect the user to $result['url'] if it’s an external signature page.

Handling Callbacks

1. In config, each provider has a 'callback_url'.
2. The package routes POST /docsign/callback/{provider} to RouteCallbacks@signatureCallback.
3. That calls DocSign::handleCallback($provider, $request).
4. The provider then sets doc.status='completed' (or similar).

Example Multi-Signer Flow

If you need signers in a specific order or multiple separate sign events:

• Your own application logic can track each signer’s completion.
• Possibly re-call requestSignature(...) with the next signer or pass an array with 'order' keys.
• The package’s built-in providers are minimal stubs; advanced signers with multi-step flows are possible if you create a custom provider (or expand the existing ones).

Advanced & Unusual Use Cases

Versioning Documents

If you want doc versioning:

1. Add a version column to documents.
2. Before re-generating, increment doc.version in your application logic.
3. Store old PDFs under a versioned filename.

Security & Encryption

For truly sensitive docs:

• You can implement encryption at rest using a custom disk driver (e.g., S3’s server-side encryption).
• If you need password-protected PDFs, certain renderers or PDF post-processing can do that.

Docker Environments

If using wkhtmltopdf in Docker:

1. Add RUN apt-get update && apt-get install -y wkhtmltopdf (or a specialized image).
2. Possibly store the path in .env as WKHTMLTOPDF_PATH=/usr/bin/wkhtmltopdf.
3. The package’s test can skip if wkhtmltopdf isn’t found.

Notifications & Webhooks

Your application can:

• Listen for 'docsign.callback' route and then send emails or Slack messages.
• Fire your own events upon doc creation, signature requested, or completion.

Expandability

Custom PDF Engines

1. Create a class implementing MrNewport\LaravelDocSign\Services\Pdf\PdfRendererInterface.

2. Bind it in your app:

3. Set 'pdf_renderer' => 'mycustom' in docsign.php.

Custom Template Engines

1. Implement MrNewport\LaravelDocSign\Services\Template\TemplateEngineInterface.

2. Bind in your AppServiceProvider:

3. 'template_engine' => 'markdown'.

Custom Signature Providers

1. Implement SignatureProviderInterface.
2. Add it to config('docsign.signature.providers').
3. No package edits. If 'key' => 'mysigner', then 'class' => \App\Signing\MySignerProvider::class.

Testing

• DocumentTest: verifies doc creation & PDF generation.
• SignatureTest: checks requestSignature + local callback.
• PdfTest: tests DomPDF or Wkhtml if installed.
• TemplateTest: tests Blade & Twig.

In CI or local dev, ensure you have wkhtmltopdf installed if you want that test to pass. DomPDF-based tests do not require extra binaries.

License

This package is open-sourced software licensed under the MIT license. Expand it solely via config or custom classes—never by editing the package’s internal files. Enjoy your dynamic documents and e-sign workflows!