README

An all-in-one PHP/Laravel library to generate professional documents in PDF, Excel, Word, and CSV formats with specialized support for Bangla Unicode and built-in API Token Security.

🚀 Features

Blade Template Support: Use Laravel Blade views for custom PDF layouts
- Bangla Support: Seamlessly handles Bangla Unicode characters in PDFs using DejaVu Sans.
- Multi-Format: One interface for 4 major document types.
- Secure: Built-in logic for Main and Safe API tokens for external integrations.
- Performant: Optimized for speed and minimal memory footprint.
- API Ready: Perfect for REST APIs with token-based authentication

🛠 Installation

You can install the package via composer:

composer require shoaib3375/php-doc-exporter

Laravel Setup (Optional)

The package auto-registers in Laravel. Optionally publish the config:

php artisan vendor:publish --provider="Shoaib3375\PhpDocExporter\PhpDocExporterServiceProvider"

Then configure tokens in .env:

PHP_DOC_EXPORTER_MAIN_TOKEN=your-main-token
PHP_DOC_EXPORTER_SAFE_TOKEN=your-safe-token

📖 Quick Start

Basic Usage (Plain PHP)

use Shoaib3375\PhpDocExporter\DocumentExporter;

$data = [
    ['name' => 'Shoaib', 'age' => 25, 'city' => 'Dhaka'],
    ['name' => 'মাইনুল', 'age' => 30, 'city' => 'Sylhet']
];

$exporter = new DocumentExporter();
$content = $exporter->export('pdf', $data);

// Save to file
file_put_contents('report.pdf', $content);

Laravel Controller Example

use Shoaib3375\PhpDocExporter\DocumentExporter;
use Illuminate\Http\Request;

public function export(Request $request)
{
    $data = [
        ['name' => 'Shoaib', 'age' => 25, 'city' => 'Dhaka'],
        ['name' => 'মাইনুল', 'age' => 30, 'city' => 'Sylhet']
    ];

    $exporter = new DocumentExporter();
    $format = $request->input('format', 'pdf'); // pdf, excel, word, csv
    
    $content = $exporter->export($format, $data);
    
    $extension = match($format) {
        'excel' => 'xlsx',
        'word' => 'docx',
        default => $format
    };
    
    return response($content)
        ->header('Content-Type', $this->getMimeType($format))
        ->header('Content-Disposition', 'attachment; filename="report.' . $extension . '"');
}

private function getMimeType($format) {
    return match($format) {
        'pdf' => 'application/pdf',
        'excel' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
        'word' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
        'csv' => 'text/csv',
    };
}

Using Blade Templates (NEW)

use Shoaib3375\PhpDocExporter\DocumentExporter;

public function exportInvoice(Request $request)
{
    $data = [
        'title' => 'Sales Invoice',
        'invoiceNumber' => 'INV-2024-001',
        'customerName' => 'মোহাম্মদ শোয়েব',
        'items' => [
            ['name' => 'Product A', 'quantity' => 2, 'price' => 500],
            ['name' => 'পণ্য বি', 'quantity' => 1, 'price' => 1000],
        ],
        'total' => 2000
    ];

    $exporter = new DocumentExporter();
    $content = $exporter->exportFromView('pdf', 'invoice', $data, [
        'paper' => 'A4',
        'orientation' => 'portrait'
    ]);

    return response($content)
        ->header('Content-Type', 'application/pdf')
        ->header('Content-Disposition', 'attachment; filename="invoice.pdf"');
}

API with Token Authentication

Route::middleware('auth:sanctum')->post('/export/invoice', function (Request $request) {
    $token = $request->bearerToken();
    
    $data = ['title' => 'Invoice', 'items' => [...]];
    
    $exporter = new DocumentExporter();
    $content = $exporter->exportFromView('pdf', 'invoice', $data, [], $token);
    
    return response($content)
        ->header('Content-Type', 'application/pdf')
        ->header('Content-Disposition', 'attachment; filename="invoice.pdf"');
});

🎨 Blade Template Support

Creating a Blade Template

Create a view file at resources/views/invoice.blade.php:

<!DOCTYPE html>
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <style>
        body { font-family: 'DejaVu Sans', sans-serif; }
        table { width: 100%; border-collapse: collapse; }
        th, td { border: 1px solid #000; padding: 8px; }
    </style>
</head>
<body>
    <h1>{{ $title }}</h1>
    <p>Invoice #{{ $invoiceNumber }}</p>
    
    <table>
        <thead>
            <tr>
                <th>Item</th>
                <th>Quantity</th>
                <th>Price</th>
            </tr>
        </thead>
        <tbody>
            @foreach($items as $item)
            <tr>
                <td>{{ $item['name'] }}</td>
                <td>{{ $item['quantity'] }}</td>
                <td>{{ $item['price'] }}</td>
            </tr>
            @endforeach
        </tbody>
    </table>
    
    <p><strong>Total: {{ $total }}</strong></p>
</body>
</html>

Using the Template

$exporter = new DocumentExporter();
$content = $exporter->exportFromView('pdf', 'invoice', [
    'title' => 'Sales Invoice',
    'invoiceNumber' => 'INV-001',
    'items' => [...],
    'total' => 2000
]);

Benefits

Custom Layouts: Design complex documents with full HTML/CSS control
- Reusable Templates: Share templates across your application
- Dynamic Content: Use Blade directives (@if, @foreach, @include)
- Bangla Support: Full Unicode support in templates

🎨 Advanced Options

PDF Customization

$options = [
    'title' => 'Sales Report',
    'paper' => 'A4',           // A4, Letter, Legal
    'orientation' => 'landscape', // portrait or landscape
    'font' => 'DejaVu Sans'    // Default font for Unicode support
];

$content = $exporter->export('pdf', $data, $options);

Word/Excel Customization

$options = [
    'title' => 'Monthly Report'
];

$content = $exporter->export('word', $data, $options);

Data Format

Use associative arrays where keys become column headers:

$data = [
    ['name' => 'John', 'email' => 'john@example.com'],
    ['name' => 'জন', 'email' => 'john@example.bd']
];

🔒 API Token Security (Optional)

Using Tokens for Protected Exports

$exporter = new DocumentExporter();

// Export with token validation
$content = $exporter->export('pdf', $data, [], $apiToken);
// Throws InvalidArgumentException if token is invalid

Custom Token Configuration

use Shoaib3375\PhpDocExporter\Config;

$config = new Config();

// Validate tokens
if ($config->canAccessFullApi($token)) {
    // Full access: create, edit, update
}

if ($config->canAccessSafeApi($token)) {
    // Safe access: export only
}

🇧🇩 Bangla Unicode Support

All formats (PDF, Excel, Word, CSV) fully support Bangla and other Unicode characters.

Important: For full Bangla support in PDFs, use a dedicated Bangla font like Noto Sans Bengali, Kalpurush, or SolaimanLipi. The default DejaVu Sans has limited Bangla character support.

Recommended Usage

$data = [
    ['নাম' => 'শোয়েব', 'বয়স' => '২৫', 'শহর' => 'ঢাকা'],
    ['নাম' => 'মাইনুল', 'বয়স' => '৩০', 'শহর' => 'সিলেট']
];

// Specify a Bangla-compatible font
$content = $exporter->export('pdf', $data, [
    'font' => 'Noto Sans Bengali'  // or 'Kalpurush', 'SolaimanLipi'
]);
file_put_contents('bangla-report.pdf', $content);

In Blade Templates

<style>
    body { font-family: 'Noto Sans Bengali', sans-serif; }
</style>

Note: See BANGLA_FONT_GUIDE.md for detailed font installation and configuration instructions.

📄 API Reference

`DocumentExporter`

`exportFromView(string $format, string $view, array $data = [], array $options = [], string $token = null): string`

Generates PDF from Blade template (Laravel only).

Parameters:

$format - Currently only 'pdf' supported for views
- $view - Blade view name (e.g., 'invoice' for resources/views/invoice.blade.php)
- $data - Data to pass to the Blade view
- $options - Optional settings:
  - paper - PDF paper size (A4, Letter, Legal)
  - orientation - PDF orientation (portrait, landscape)
  - font - PDF font (default: DejaVu Sans)
- $token - Optional API token for validation

Returns: PDF content as string

Throws: InvalidFormatException or InvalidTokenException

`export(string $format, array $data, array $options = [], string $token = null): string`

Generates document content and returns as string.