README

Laraigniter wrapper for Dompdf HTML to PDF Converter

Installation

Laraigniter

Require this package in your composer.json and update composer. This will download the package and the dompdf + fontlib libraries also.

composer require lara-igniter/laraigniter-dompdf

Using

You can create a new DOMPDF instance and load a HTML string, file or view name. You can save it to a file, or stream (show in browser) or download.

    use Laraigniter\DomPDF\Facade\Pdf;

    $pdf = Pdf::view('emails.invoice', [
        'data' => $data
    ]);
    
    return $pdf->download('example.pdf');

or use the app() controller instance:

    $pdf = app('dompdf.wrapper');
    $pdf->html('<h1>Example PDF</h1>');
    
    return $pdf->stream();

Or use the facade:

You can chain the methods:

    return Pdf::file(public_path('emails/example.html'))
        ->save('example.pdf')
        ->stream('example.pdf');

You can change the orientation and paper size, and hide or show errors (by default, errors are shown when debug is on)

    Pdf::html($html)->setPaper('a4', 'landscape')
        ->setWarnings(false)
        ->save('example.pdf')

If you need the output as a string, you can get the rendered PDF with the output() function, so you can save/output it yourself.

Configuration

The defaults configuration settings are set in config/dompdf.php.

You can still alter the dompdf options in your code before generating the pdf using this command:

    Pdf::setOption(['dpi' => 150, 'defaultFont' => 'sans-serif']);

Available options and their defaults:

rootDir: "{app_directory}/vendor/dompdf/dompdf"
tempDir: "/tmp" (available in config/dompdf.php)
fontDir: "{app_directory}/storage/fonts" (available in config/dompdf.php)
fontCache: "{app_directory}/storage/fonts" (available in config/dompdf.php)
chroot: "{app_directory}" (available in config/dompdf.php)
logOutputFile: "/tmp/log.htm"
defaultMediaType: "screen" (available in config/dompdf.php)
defaultPaperSize: "a4" (available in config/dompdf.php)
defaultFont: "serif" (available in config/dompdf.php)
dpi: 96 (available in config/dompdf.php)
fontHeightRatio: 1.1 (available in config/dompdf.php)
isPhpEnabled: false (available in config/dompdf.php)
isRemoteEnabled: false (available in config/dompdf.php)
isJavascriptEnabled: true (available in config/dompdf.php)
isHtml5ParserEnabled: true (available in config/dompdf.php)
allowedRemoteHosts: null (available in config/dompdf.php)
isFontSubsettingEnabled: false (available in config/dompdf.php)
debugPng: false
debugKeepTemp: false
debugCss: false
debugLayout: false
debugLayoutLines: true
debugLayoutBlocks: true
debugLayoutInline: true
debugLayoutPaddingBox: true
pdfBackend: "CPDF" (available in config/dompdf.php)
pdflibLicense: ""
adminUsername: "user"
adminPassword: "password"
artifactPathValidation: null (available in config/dompdf.php)

Note: Remote access is disabled by default, to provide more security. Use with caution!

Tip: UTF-8 support

In your templates, set the UTF-8 Metatag:

<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>

Tip: Page breaks

You can use the CSS page-break-before/page-break-after properties to create a new page.

<style>
.page-break {
    page-break-after: always;
}
</style>
<h1>Page 1</h1>
<div class="page-break"></div>
<h1>Page 2</h1>

License

This DOMPDF Wrapper for Laraigniter is open-sourced software licensed under the MIT license

lara-igniter / laraigniter-dompdf

Maintainers

Details