PHPackages                             ayoratoumvone/documentgeneratorx - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Templating & Views](/categories/templating)
4. /
5. ayoratoumvone/documentgeneratorx

ActiveLibrary[Templating & Views](/categories/templating)

ayoratoumvone/documentgeneratorx
================================

A package to generate documents (DOCX/PDF) based on templates with advanced variable types including images.

v2.0.1(2mo ago)030↓50%MITPHPPHP ^8.1

Since Feb 5Pushed 2mo agoCompare

[ Source](https://github.com/Ayoratou99/documentgeneratorx)[ Packagist](https://packagist.org/packages/ayoratoumvone/documentgeneratorx)[ RSS](/packages/ayoratoumvone-documentgeneratorx/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (7)Versions (5)Used By (0)

DocumentGeneratorX
==================

[](#documentgeneratorx)

A Laravel package to generate **PDF documents** from DOCX or HTML templates with variable replacement, styling support, batch generation, and queue integration for parallel processing.

[![Latest Version on Packagist](https://camo.githubusercontent.com/c8f8d22d7f7f49063275ead0bb036103a9367d3a3d68b178b6c31bee50a70832/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f61796f7261746f756d766f6e652f646f63756d656e7467656e657261746f72782e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ayoratoumvone/documentgeneratorx)[![Total Downloads](https://camo.githubusercontent.com/cf7f3ac31784a58fddbd62a3d520c0762f89bb77b8d82caee9edce80ea02135a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f61796f7261746f756d766f6e652f646f63756d656e7467656e657261746f72782e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ayoratoumvone/documentgeneratorx)

Features
--------

[](#features)

- **PDF Output**: All documents are generated as high-quality PDF
- **DOCX Templates**: Use Microsoft Word documents as templates
- **HTML Templates**: Use HTML files as templates
- **Variable Styling**: Apply colors, bold, italic, and more to variables
- **Image Support**: Insert images with custom dimensions
- **Batch Generation**: Generate multiple documents at once
- **Queue Support**: Process documents in background with Laravel queues
- **Event System**: Hook into generation lifecycle with Laravel events
- **LibreOffice Integration**: Best quality PDF output (default)

Installation
------------

[](#installation)

```
composer require ayoratoumvone/documentgeneratorx
```

Publish the config file:

```
php artisan vendor:publish --tag="documentgenerator-config"
```

Quick Start
-----------

[](#quick-start)

```
use Ayoratoumvone\Documentgeneratorx\Facades\DocumentGenerator;

// Generate PDF from DOCX template
$pdfPath = DocumentGenerator::template('template.docx')
    ->variables([
        'name' => 'John Doe',
        'photo' => 'https://example.com/photo.jpg',
    ])
    ->generate();
```

---

Table of Contents
-----------------

[](#table-of-contents)

- [Variable Syntax](#variable-syntax)
- [Styling Variables](#styling-variables)
- [Single Document Generation](#single-document-generation)
- [Batch Generation](#batch-generation)
- [Queue & Events (Parallel Processing)](#queue--events-parallel-processing)
- [PDF Conversion Methods](#pdf-conversion-methods)
- [Configuration](#configuration)
- [Standalone Usage](#standalone-usage)

---

Variable Syntax
---------------

[](#variable-syntax)

Use double curly braces with type annotations in your template:

```
{{variable_name:type,option1:value1,option2:value2}}

```

### Supported Types

[](#supported-types)

TypeSyntaxExample ValueText`{{name:text}}``'John Doe'`Number`{{age:number}}``25`Image`{{photo:image,width:200,height:100}}``'path/to/image.jpg'`Date`{{date:date}}``'2024-01-15'`Boolean`{{active:boolean}}``true`### Image Options

[](#image-options)

```
{{logo:image}}                           // Default size
{{photo:image,width:200}}                // Fixed width
{{banner:image,width:200,height:100}}    // Fixed dimensions
{{avatar:image,ratio:1:1}}               // Aspect ratio

```

---

Styling Variables
-----------------

[](#styling-variables)

Apply styling directly in template placeholders:

```
{{title:text,color:red,bold:true}}
{{name:text,font-size:18,underline:true}}
{{warning:text,color:#FF0000,background-color:#FFFF00}}

```

### Supported Style Properties

[](#supported-style-properties)

PropertyExampleDescription`color``color:red` or `color:#FF0000`Text color`bold``bold:true`Bold text`italic``italic:true`Italic text`underline``underline:true`Underlined text`font-size``font-size:14`Font size in points`font-family``font-family:Arial`Font family`background-color``background-color:#FFFF00`Highlight color### Named Colors

[](#named-colors)

`red`, `green`, `blue`, `black`, `white`, `yellow`, `orange`, `purple`, `pink`, `gray`, `brown`, `navy`, `teal`, `maroon`

---

Single Document Generation
--------------------------

[](#single-document-generation)

Methods for generating **one document at a time**.

### Available Methods

[](#available-methods)

MethodDescriptionReturns`generate($path)`Generate PDF to file pathFile path`download($filename)`Generate and return download responseHTTP Response`generateToStorage($path, $disk)`Generate and save to Laravel storageStorage path### Generate to File

[](#generate-to-file)

```
use Ayoratoumvone\Documentgeneratorx\Facades\DocumentGenerator;

$pdfPath = DocumentGenerator::template('invoice.docx')
    ->variables([
        'customer_name' => 'John Doe',
        'total' => '$1,234.00',
    ])
    ->generate('invoices/invoice-001.pdf');
```

### Download Response (Single Document Only)

[](#download-response-single-document-only)

```
// Returns a download response - works for SINGLE document only
return DocumentGenerator::template('contract.docx')
    ->variables(['name' => 'John Doe'])
    ->download('contract.pdf');
```

### Save to Storage

[](#save-to-storage)

```
$path = DocumentGenerator::template('report.docx')
    ->variables(['title' => 'Monthly Report'])
    ->generateToStorage('reports/march-2024.pdf', 'public');
```

---

Batch Generation
----------------

[](#batch-generation)

Generate **multiple documents** at once. Returns an array of results.

> **Note:** `download()` is NOT available for batch generation. You cannot download multiple files in a single HTTP response. For batch downloads, generate files then create a ZIP archive.

### Available Methods

[](#available-methods-1)

MethodDescriptionReturns`generateBatch($documents)`Generate multiple PDFs (same template)Array of results`batchGenerate($documents)`Generate multiple PDFs (different templates)Array of results### Same Template, Different Data

[](#same-template-different-data)

```
use Ayoratoumvone\Documentgeneratorx\Facades\DocumentGenerator;

$generator = DocumentGenerator::template('certificate.docx');

$results = $generator->generateBatch([
    ['variables' => ['name' => 'Alice Johnson'], 'output' => 'certs/alice.pdf'],
    ['variables' => ['name' => 'Bob Smith'], 'output' => 'certs/bob.pdf'],
    ['variables' => ['name' => 'Carol White'], 'output' => 'certs/carol.pdf'],
]);

// Check results
foreach ($results as $result) {
    if ($result['success']) {
        echo "Generated: {$result['path']}\n";
    } else {
        echo "Failed: {$result['error']}\n";
    }
}
```

### Different Templates

[](#different-templates)

```
use Ayoratoumvone\Documentgeneratorx\DocumentGenerator;

$results = DocumentGenerator::batchGenerate([
    [
        'template' => 'invoice.docx',
        'variables' => ['customer' => 'John', 'total' => '$500'],
        'output' => 'docs/invoice.pdf',
    ],
    [
        'template' => 'contract.docx',
        'variables' => ['client' => 'Jane', 'date' => '2024-01-15'],
        'output' => 'docs/contract.pdf',
    ],
]);
```

### Progress Callback

[](#progress-callback)

```
$results = $generator->generateBatch($documents, false, function($completed, $total, $path) {
    $percent = round(($completed / $total) * 100);
    echo "Progress: {$percent}% ({$completed}/{$total})\n";
});
```

### Download Multiple Documents as ZIP

[](#download-multiple-documents-as-zip)

To let users download multiple documents, create a ZIP file:

```
use ZipArchive;

// Generate batch
$results = $generator->generateBatch($documents);

// Create ZIP with successful files
$zipPath = storage_path('app/temp/documents.zip');
$zip = new ZipArchive();
$zip->open($zipPath, ZipArchive::CREATE | ZipArchive::OVERWRITE);

foreach ($results as $result) {
    if ($result['success']) {
        $zip->addFile($result['path'], basename($result['path']));
    }
}
$zip->close();

// Return ZIP download
return response()->download($zipPath, 'documents.zip')->deleteFileAfterSend(true);
```

---

Queue & Events (Parallel Processing)
----------------------------------------

[](#queue--events-parallel-processing)

For generating many documents simultaneously, use Laravel's queue system with the built-in job and events. Each document gets a **system-generated `documentId`** that you can use to track its progress.

### Why Use Queues?

[](#why-use-queues)

- **Parallel Processing**: Generate multiple documents at the same time
- **Background Processing**: Don't block web requests
- **Reliability**: Automatic retries on failure
- **Scalability**: Distribute work across multiple queue workers
- **Tracking**: Each document gets a unique ID for status tracking

### Generate Single Document in Queue

[](#generate-single-document-in-queue)

```
use Ayoratoumvone\Documentgeneratorx\Jobs\GenerateDocument;

// Create the job to get the document ID
$job = new GenerateDocument(
    templatePath: storage_path('templates/invoice.docx'),
    variables: ['customer' => 'John Doe', 'total' => '$1,234'],
    outputPath: storage_path('app/invoices/invoice-001.pdf')
);

// Get the document ID for tracking (store this in your database)
$documentId = $job->documentId;  // e.g., "doc_550e8400-e29b-41d4-a716-446655440000"

// Save to your database
DocumentRequest::create([
    'document_id' => $documentId,
    'user_id' => auth()->id(),
    'status' => 'pending',
]);

// Dispatch the job
dispatch($job);

// Return the document ID to user so they can check status later
return response()->json(['document_id' => $documentId, 'status' => 'processing']);
```

### Generate Multiple Documents in Parallel

[](#generate-multiple-documents-in-parallel)

Use the `GenerateDocumentBatch` helper:

```
use Ayoratoumvone\Documentgeneratorx\Jobs\GenerateDocumentBatch;

// Create batch
$batchHelper = GenerateDocumentBatch::create([
    ['template' => 'invoice.docx', 'variables' => ['name' => 'Alice'], 'output' => 'alice.pdf'],
    ['template' => 'invoice.docx', 'variables' => ['name' => 'Bob'], 'output' => 'bob.pdf'],
    ['template' => 'invoice.docx', 'variables' => ['name' => 'Carol'], 'output' => 'carol.pdf'],
]);

// Get all document IDs BEFORE dispatching (store these in your database)
$documentIds = $batchHelper->getDocumentIds();
// ['doc_abc123...', 'doc_def456...', 'doc_ghi789...']

// Save to your database for tracking
foreach ($documentIds as $documentId) {
    DocumentRequest::create([
        'document_id' => $documentId,
        'user_id' => auth()->id(),
        'status' => 'pending',
    ]);
}

// Now dispatch
$batch = $batchHelper
    ->name('Monthly Invoices')
    ->onQueue('documents')
    ->dispatch();

// Return document IDs to user
return response()->json([
    'batch_id' => $batchHelper->getBatchId(),
    'document_ids' => $documentIds,
    'status' => 'processing',
]);
```

### Tracking Document Status with Events

[](#tracking-document-status-with-events)

When documents complete (or fail), events fire with the `documentId`. Use listeners to update your database:

```
// In your EventServiceProvider
protected $listen = [
    \Ayoratoumvone\Documentgeneratorx\Events\DocumentGenerated::class => [
        \App\Listeners\UpdateDocumentStatus::class,
    ],
    \Ayoratoumvone\Documentgeneratorx\Events\DocumentGenerationFailed::class => [
        \App\Listeners\HandleDocumentFailure::class,
    ],
];
```

```
// app/Listeners/UpdateDocumentStatus.php
class UpdateDocumentStatus
{
    public function handle(DocumentGenerated $event): void
    {
        // Find your record using the document ID
        $request = DocumentRequest::where('document_id', $event->documentId)->first();

        if ($request) {
            $request->update([
                'status' => 'completed',
                'file_path' => $event->outputPath,
                'completed_at' => now(),
            ]);

            // Notify the user
            $request->user->notify(new DocumentReadyNotification($event->outputPath));
        }
    }
}
```

### API Endpoint Example

[](#api-endpoint-example)

```
// Controller: Start document generation
public function generateInvoice(Request $request)
{
    $job = new GenerateDocument(
        'invoice.docx',
        ['customer' => $request->customer_name, 'total' => $request->total],
        "invoices/{$request->invoice_id}.pdf"
    );

    // Store for tracking
    DocumentRequest::create([
        'document_id' => $job->documentId,
        'user_id' => auth()->id(),
        'type' => 'invoice',
        'status' => 'processing',
    ]);

    dispatch($job);

    return response()->json([
        'document_id' => $job->documentId,
        'message' => 'Document is being generated',
    ]);
}

// Controller: Check status
public function checkStatus(string $documentId)
{
    $request = DocumentRequest::where('document_id', $documentId)
        ->where('user_id', auth()->id())
        ->firstOrFail();

    return response()->json([
        'document_id' => $documentId,
        'status' => $request->status,
        'file_path' => $request->file_path,
        'completed_at' => $request->completed_at,
    ]);
}
```

### Events

[](#events)

The package fires events at each stage of document generation. Use these to add custom logic.

EventWhen FiredUse Case`DocumentGenerating`Before generation startsValidate, log start`DocumentGenerated`After successful generationNotify user, move file`DocumentGenerationFailed`When generation failsLog error, notify admin`BatchGenerationCompleted`When batch finishesZip files, send summary### Setting Up Event Listeners

[](#setting-up-event-listeners)

**1. Publish example listeners:**

```
php artisan vendor:publish --tag="documentgenerator-listeners"
```

**2. Register listeners in `EventServiceProvider`:**

```
// app/Providers/EventServiceProvider.php

use Ayoratoumvone\Documentgeneratorx\Events\DocumentGenerated;
use Ayoratoumvone\Documentgeneratorx\Events\DocumentGenerationFailed;
use Ayoratoumvone\Documentgeneratorx\Events\BatchGenerationCompleted;
use App\Listeners\DocumentGenerator\LogDocumentGenerated;
use App\Listeners\DocumentGenerator\NotifyDocumentReady;
use App\Listeners\DocumentGenerator\HandleGenerationFailed;
use App\Listeners\DocumentGenerator\HandleBatchCompleted;

protected $listen = [
    DocumentGenerated::class => [
        LogDocumentGenerated::class,
        NotifyDocumentReady::class,
    ],
    DocumentGenerationFailed::class => [
        HandleGenerationFailed::class,
    ],
    BatchGenerationCompleted::class => [
        HandleBatchCompleted::class,
    ],
];
```

### Example: Notify User When Document is Ready

[](#example-notify-user-when-document-is-ready)

```
// app/Listeners/DocumentGenerator/NotifyDocumentReady.php

namespace App\Listeners\DocumentGenerator;

use Ayoratoumvone\Documentgeneratorx\Events\DocumentGenerated;
use App\Models\DocumentRequest;
use App\Notifications\DocumentReadyNotification;

class NotifyDocumentReady
{
    public function handle(DocumentGenerated $event): void
    {
        // Find the document request using the system-generated documentId
        $request = DocumentRequest::where('document_id', $event->documentId)->first();

        if ($request) {
            // Update status
            $request->update([
                'status' => 'completed',
                'file_path' => $event->outputPath,
            ]);

            // Notify the user who requested this document
            $request->user->notify(new DocumentReadyNotification(
                $event->outputPath,
                $event->getFileSizeFormatted()
            ));
        }
    }
}
```

### Example: Create ZIP of Batch Documents

[](#example-create-zip-of-batch-documents)

```
// app/Listeners/DocumentGenerator/HandleBatchCompleted.php

use Ayoratoumvone\Documentgeneratorx\Events\BatchGenerationCompleted;
use ZipArchive;

class HandleBatchCompleted
{
    public function handle(BatchGenerationCompleted $event): void
    {
        if (!$event->isFullySuccessful()) {
            Log::warning("Batch {$event->batchId} had {$event->failedCount} failures");
            return;
        }

        // Create ZIP with all documents
        $zipPath = storage_path("app/batches/{$event->batchId}.zip");
        $zip = new ZipArchive();
        $zip->open($zipPath, ZipArchive::CREATE);

        foreach ($event->getSuccessfulPaths() as $path) {
            $zip->addFile($path, basename($path));
        }

        $zip->close();

        Log::info("Batch ZIP created: {$zipPath}");
    }
}
```

### Running Queue Workers

[](#running-queue-workers)

Start queue workers to process document generation jobs:

```
# Single worker
php artisan queue:work

# Multiple workers for parallel processing
php artisan queue:work --queue=documents &
php artisan queue:work --queue=documents &
php artisan queue:work --queue=documents &

# Using Supervisor (production)
# See Laravel docs: https://laravel.com/docs/queues#supervisor-configuration
```

---

PDF Conversion Methods
----------------------

[](#pdf-conversion-methods)

### LibreOffice (Default - Best Quality)

[](#libreoffice-default---best-quality)

Uses LibreOffice for pixel-perfect PDF conversion. **Recommended for production.**

**Install LibreOffice:**

- Windows: [Download](https://www.libreoffice.org/download/download/)
- Linux: `sudo apt install libreoffice`
- macOS: `brew install libreoffice`

```
DOCUMENT_PDF_CONVERSION=libreoffice
LIBREOFFICE_PATH="C:\Program Files\LibreOffice\program\soffice.exe"
```

### Dompdf (HTML-based Fallback)

[](#dompdf-html-based-fallback)

No external dependencies, but may not preserve all formatting.

```
DOCUMENT_PDF_CONVERSION=dompdf
```

### Error Handling

[](#error-handling)

If LibreOffice is not installed, you'll get a helpful error:

```
LibreOffice is not installed or not found on this system.

To fix this, you have two options:

1. Install LibreOffice (recommended for best PDF quality):
   Download from: https://www.libreoffice.org/download/download/
   Then set the path in your .env file:
   LIBREOFFICE_PATH="C:\Program Files\LibreOffice\program\soffice.exe"

2. Use HTML-based conversion (no LibreOffice required):
   Set in your .env file:
   DOCUMENT_PDF_CONVERSION=dompdf

```

---

Configuration
-------------

[](#configuration)

```
// config/documentgenerator.php

return [
    // PDF conversion method: 'libreoffice' (default) or 'dompdf'
    'pdf_conversion' => env('DOCUMENT_PDF_CONVERSION', 'libreoffice'),

    // LibreOffice executable path (auto-detected if not set)
    'libreoffice_path' => env('LIBREOFFICE_PATH', null),

    // Default template storage path
    'template_path' => storage_path('app/document-templates'),

    // Default output path for permanent files
    'output_path' => storage_path('app/generated-documents'),

    // Save to temp directory (auto-deleted)
    'temp_output' => true,

    // Delete file after download() response
    'delete_after_download' => true,

    // Cleanup temp files on script end
    'cleanup_on_shutdown' => true,

    // Default storage disk
    'disk' => 'local',
];
```

---

Standalone Usage (Without Laravel)
----------------------------------

[](#standalone-usage-without-laravel)

```
require 'vendor/autoload.php';

use Ayoratoumvone\Documentgeneratorx\Generators\DocxToPdfGenerator;

$generator = new DocxToPdfGenerator();

// Set LibreOffice path
$generator->setLibreOfficePath('C:\Program Files\LibreOffice\program\soffice.exe');

// Generate PDF
$generator->generate(
    'template.docx',
    ['name' => 'John Doe', 'date' => '2024-01-15'],
    'output.pdf'
);
```

---

Requirements
------------

[](#requirements)

- PHP 8.1+
- Laravel 9.x, 10.x, 11.x, or 12.x
- GD extension for image processing
- LibreOffice (recommended) or Dompdf

---

License
-------

[](#license)

MIT License. See [LICENSE.md](LICENSE.md) for details.

Author
------

[](#author)

- [Ayoratoumvone](https://github.com/Ayoratou99)

###  Health Score

40

—

FairBetter than 87% of packages

Maintenance90

Actively maintained with recent releases

Popularity10

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~4 days

Total

4

Last Release

79d ago

Major Versions

v1.0.1 → v2.0.02026-02-05

### Community

Maintainers

![](https://www.gravatar.com/avatar/a2cfe1b651821031083a9d74d53a09a09f1614c0b12b19e6555e71863a45c055?d=identicon)[Ayoratou99](/maintainers/Ayoratou99)

---

Top Contributors

[![Ayoratou99](https://avatars.githubusercontent.com/u/44085615?v=4)](https://github.com/Ayoratou99 "Ayoratou99 (7 commits)")

---

Tags

laravelpdftemplatedocxPhpWorddompdfdocument generatordocument generation

###  Code Quality

TestsPHPUnit

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/ayoratoumvone-documentgeneratorx/health.svg)

```
[![Health](https://phpackages.com/badges/ayoratoumvone-documentgeneratorx/health.svg)](https://phpackages.com/packages/ayoratoumvone-documentgeneratorx)
```

###  Alternatives

[phpoffice/phpword

PHPWord - A pure PHP library for reading and writing word processing documents (OOXML, ODF, RTF, HTML, PDF)

7.5k34.7M182](/packages/phpoffice-phpword)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)