toolreport/core

PDF Designer for Laravel — template management, layout engine, dual PDF rendering (DomPDF + Composite TCPDF)

0.1.6 2026-07-20 19:05 UTC

Requires

• php: ^8.3
• barryvdh/laravel-dompdf: ^3.0
• tecnickcom/tc-lib-pdf: ^8

Requires (Dev)

• laravel/framework: ^13.0
• orchestra/testbench: ^11.0
• phpunit/phpunit: ^12.0

MIT

• pdf
• TCPDF
• layout
• templates
• report
• laravel
• dompdf
• designer

Published on Packagist.org on 2026-07-20 19:10 UTC

README

📖 Documentación en Español · English docs below

PDF Designer for Laravel — template management, visual layout engine, and dual PDF rendering (DomPDF + TCPDF composite engine).

Requirements

• PHP 8.3+
• Laravel 13+
• DomPDF (barryvdh/laravel-dompdf)
• TCPDF composite engine (tecnickcom/tc-lib-pdf)

Installation

composer require toolreport/core

Publish configuration and run migrations:

php artisan pdf-designer:install

Or publish manually:

# Config
php artisan vendor:publish --tag=pdf-designer-config

# Migrations
php artisan vendor:publish --tag=pdf-designer-migrations

PDF Designer

The visual designer is a Vue 3 application included in the package. After installing the PHP package, build and configure the frontend:

Setup

# Install the package
composer require toolreport/core

# Run the installer (publishes config, migrations, and views)
php artisan pdf-designer:install --with-assets

Vite Configuration

Add the designer entry point and @ alias to your vite.config.ts:

import { defineConfig } from 'vite'
import laravel from 'laravel-vite-plugin'
import vue from '@vitejs/plugin-vue'
import tailwindcss from '@tailwindcss/vite'
import { fileURLToPath } from 'url'

export default defineConfig({
    plugins: [
        laravel({
            input: [
                'resources/css/app.css',
                'vendor/toolreport/core/designer/src/main.ts',
            ],
            refresh: true,
        }),
        vue(),
        tailwindcss(),
    ],
    resolve: {
        alias: {
            '@': fileURLToPath(
                new URL('./vendor/toolreport/core/designer/src', import.meta.url),
            ),
        },
    },
})

Install Dependencies

npm install -D vue @vitejs/plugin-vue
npm install pinia axios vue-router

Tailwind v4

Tell Tailwind to scan the designer source files. Add this line to your resources/css/app.css:

@source "../../vendor/toolreport/core/designer/src/**/*.{vue,ts,js}";

Build

npm run build

Access

Navigate to http://your-app.com/pdf-designer

Customizing the View

Publish the Blade view to customize it:

php artisan vendor:publish --tag=pdf-designer-views

This publishes resources/views/vendor/pdf-designer/pdf-designer.blade.php to your app.

Configuration

After publishing, edit config/pdf-designer.php:

// API prefix (default: api/pdf-designer)
'api_prefix' => env('PDF_DESIGNER_API_PREFIX', 'api/pdf-designer'),

// Storage disk for generated PDFs
'storage' => [
    'disk' => env('PDF_DESIGNER_STORAGE_DISK', 'local'),
    'path' => env('PDF_DESIGNER_STORAGE_PATH', 'pdf-documents'),
],

// PDF engine selection per template
'pdf-engine' => [
    'enabled' => env('PDF_DESIGNER_PDF_ENGINE_ENABLED', true),
    'default_font' => env('PDF_DESIGNER_PDF_ENGINE_FONT', 'dejavusans'),
],

Usage

Programmatic (Facade)

use Toolreport\Core\Facades\PdfDesigner;
use Toolreport\Core\Models\PdfTemplate;

$template = PdfTemplate::find(1);

// Render a single template
$document = PdfDesigner::renderTemplate($template, [
    'company' => 'Acme Corp',
    'total' => '$1,234.56',
], 'Invoice #1001');

// The returned PdfDocument has file_path and file_size
echo $document->file_path; // e.g. pdf-documents/acme-corp_1.pdf

API Routes

Routes are auto-loaded by the service provider under the configured prefix (default: api/pdf-designer).

Templates

Method	Endpoint	Description
GET	/templates	List all templates
POST	/templates	Create a template
GET	/templates/{id}	Show a template
PUT	/templates/{id}	Update a template
DELETE	/templates/{id}	Delete a template
POST	/templates/{id}/duplicate	Duplicate a template
POST	/templates/{id}/generate	Generate a PDF from template

Documents

Method	Endpoint	Description
GET	/templates/{id}/documents	List documents for a template
GET	/documents/{id}	Show a document
GET	/documents/{id}/download	Download a PDF document

Compositions (Multi-page reports)

Method	Endpoint	Description
GET	/compositions	List all compositions
POST	/compositions	Create a composition
GET	/compositions/{id}	Show a composition
PUT	/compositions/{id}	Update a composition
DELETE	/compositions/{id}	Delete a composition
POST	/compositions/{id}/generate	Generate a combined PDF

Template Variables

Method	Endpoint	Description
GET	/templates/{id}/template-vars	List variables
POST	/templates/{id}/template-vars	Create a variable
PUT	/templates/{id}/template-vars/{varId}	Update a variable
DELETE	/templates/{id}/template-vars/{varId}	Delete a variable

Datasource Testing

Method	Endpoint	Description
POST	/templates/{id}/datasources/test	Test a datasource connection

Health Check

Method	Endpoint	Description
GET	/health	API health check

PDF Engines

ToolReport Core supports two rendering engines:

• DomPDF (default) — HTML-to-PDF rendering via barryvdh/laravel-dompdf. Good for simple layouts.
• PDF Engine (TCPDF composite) — Component-based rendering via tecnickcom/tc-lib-pdf. Better for complex layouts with precise positioning.

Set the engine per template via the engine field (dompdf or pdf-engine).

Testing

composer test

License

MIT