包简介

Generate PDFs in Laravel with this mPDF wrapper.

README 文档

README

Easily generate PDF documents from HTML right inside of Laravel using this mPDF wrapper.

Installation

Require this package in your composer.json or install it by running:

composer require niklasravnsborg/laravel-pdf

Note: This package supports auto-discovery features of Laravel 5.5+, You only need to manually add the service provider and alias if working on Laravel version lower then 5.5

To start using Laravel, add the Service Provider and the Facade to your config/app.php:

'providers' => [
    // ...
    niklasravnsborg\LaravelPdf\PdfServiceProvider::class
]

'aliases' => [
    // ...
    'PDF' => niklasravnsborg\LaravelPdf\Facades\Pdf::class
]

Now, you should publish package's config file to your config directory by using following command:

php artisan vendor:publish

Basic Usage

To use Laravel PDF add something like this to one of your controllers. You can pass data to a view in /resources/views.

use PDF;

function generate_pdf() {
    $data = [
        'foo' => 'bar'
    ];
    $pdf = PDF::loadView('pdf.document', $data);
    return $pdf->stream('document.pdf');
}

Other methods

It is also possible to use the following methods on the pdf object:

output(): Outputs the PDF as a string.
save($filename): Save the PDF to a file
download($filename): Make the PDF downloadable by the user.
stream($filename): Return a response with the PDF to show in the browser.

Config

If you have published config file, you can change the default settings in config/pdf.php file:

return [
    'format'           => 'A4', // See https://mpdf.github.io/paging/page-size-orientation.html
    'author'           => 'John Doe',
    'subject'          => 'This Document will explain the whole universe.',
    'keywords'         => 'PDF, Laravel, Package, Peace', // Separate values with comma
    'creator'          => 'Laravel Pdf',
    'display_mode'     => 'fullpage'
];

To override this configuration on a per-file basis use the fourth parameter of the initializing call like this:

PDF::loadView('pdf', $data, [], [
  'format' => 'A5-L'
])->save($pdfFilePath);

You can use a callback with the key 'instanceConfigurator' to access mpdf functions:

$config = ['instanceConfigurator' => function($mpdf) {
    $mpdf->SetImportUse();
    $mpdf->SetDocTemplate(/path/example.pdf, true);
}]
 
PDF::loadView('pdf', $data, [], $config)->save($pdfFilePath);

Headers and Footers

If you want to have headers and footers that appear on every page, add them to your <body> tag like this:

<htmlpageheader name="page-header">
    Your Header Content
</htmlpageheader>

<htmlpagefooter name="page-footer">
    Your Footer Content
</htmlpagefooter>

Now you just need to define them with the name attribute in your CSS:

@page {
    header: page-header;
    footer: page-footer;
}

Inside of headers and footers {PAGENO} can be used to display the page number.

Included Fonts

By default you can use all the fonts shipped with mPDF.

Custom Fonts

You can use your own fonts in the generated PDFs. The TTF files have to be located in one folder, e.g. /resources/fonts/. Add this to your configuration file (/config/pdf.php):

return [
    // ...
    'font_path' => base_path('resources/fonts/'),
    'font_data' => [
        'examplefont' => [
            'R'  => 'ExampleFont-Regular.ttf',    // regular font
            'B'  => 'ExampleFont-Bold.ttf',       // optional: bold font
            'I'  => 'ExampleFont-Italic.ttf',     // optional: italic font
            'BI' => 'ExampleFont-Bold-Italic.ttf' // optional: bold-italic font
            //'useOTL' => 0xFF,    // required for complicated langs like Persian, Arabic and Chinese
            //'useKashida' => 75,  // required for complicated langs like Persian, Arabic and Chinese
        ]
        // ...add as many as you want.
    ]
    // ...
];

Note: If you are using laravel-pdf for producing PDF documents in a complicated language (like Persian, Arabic or Chinese) you should have useOTL and useKashida indexes in your custom font definition array. If you do not use these indexes, your characters will be shown dispatched and incorrectly in the produced PDF.

Now you can use the font in CSS:

body {
    font-family: 'examplefont', sans-serif;
}

Set Protection

To set protection, you just call the SetProtection() method and pass an array with permissions, an user password and an owner password.

The passwords are optional.

There are a fews permissions: 'copy', 'print', 'modify', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-highres'.

use PDF;

function generate_pdf() {
    $data = [
        'foo' => 'bar'
    ];
    $pdf = PDF::loadView('pdf.document', $data);
    $pdf->SetProtection(['copy', 'print'], '', 'pass');
    return $pdf->stream('document.pdf');
}

Find more information to SetProtection() here: https://mpdf.github.io/reference/mpdf-functions/setprotection.html

Testing

To use the testing suite, you need some extensions and binaries for your local PHP. On macOS, you can install them like this:

brew install imagemagick ghostscript
pecl install imagick

License

Laravel PDF is open-sourced software licensed under the MIT license

imjcw/laravel-pdf 适用场景与选型建议

imjcw/laravel-pdf 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 2.29k 次下载、GitHub Stars 达 0，最近一次更新时间为 2020 年 07 月 06 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「pdf」「mpdf」「laravel」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 imjcw/laravel-pdf 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 imjcw/laravel-pdf 我们能提供哪些服务？

定制开发 / 二次开发

基于 imjcw/laravel-pdf 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 imjcw/laravel-pdf 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

rezgui/laravel-mpdf-dz 0

Laravel MPdf : Easily generate PDF files with arabic support

vzool/laravel-pdf 1

Generate PDFs in Laravel with this mPDF wrapper.

gonzakpo/tcpdfbundle 0

Provides TCPDF integration for Symfony

willmav5000/laravel-mpdf 0

A mPDF Wrapper for Laravel

peripteraptos/laravel-pdf 0

Generate PDFs in Laravel with this mPDF wrapper.

foxtes/alfabank-rest 1

Alfabank REST API integration

imjcw/laravel-pdf

包简介

关键字：

README 文档

README

Installation

Basic Usage

Other methods

Config

Headers and Footers

Included Fonts

Custom Fonts

Set Protection

Testing

License

imjcw/laravel-pdf 适用场景与选型建议

与 imjcw/laravel-pdf 相关的其它包

统计信息

GitHub 信息

其他信息