mathieutu/laravel-pdflayer

Laravel 的 pdflayer API 桥接器

2.0.1 2018-03-03 13:37 UTC

This package is auto-updated.

Last update: 2024-09-29 04:53:13 UTC


README

pdflayer.com 是一个面向开发者的 HTML 转 PDF 转换 API。此包是使用 PHP Laravel 框架调用此 API 的非官方桥接器。

Travis build StyleCI Test coverage Code quality Packagist downloads Stable version

安装

在您的 composer.json 中要求此包并更新 composer。

composer require mathieutu/laravel-pdflayer

用法

您可以创建一个新的 PDFLayer 实例,并加载一个 HTML 字符串、文件、视图名称,甚至是一个 URL。您可以将其保存到文件、流(在浏览器中显示)或下载。

要创建一个新的实例,您可以使用 App 类、app() 辅助函数、使用 外观,或者(更好)使用 自动依赖注入

$pdf = App::make('pdflayer');
$pdf = app('pdflayer');
$pdf = PDF::anyMethod();
public function downloadPdf(MathieuTu\PDFLayer\PDF $pdf) {}

您可以链式调用方法

return $pdf->loadView('pdf.invoice', $data)->setPaper('a4', 'landscape')->save('/path-to/my_stored_file.pdf')->stream('download.pdf');

您可以通过使用 setXXX 方法(其中 XXX 是 StudlyCase 中的参数)来设置 pdflayer 文档 中提供的所有参数,或者将参数(以原始 snake_case 设置)作为对象的属性设置。

$pdf->loadHTML('<h1>Hello!</h1>')->setWatermarkInBackground(true);
$pdf->margin_top = 134;
$pdf->save('myfile.pdf');

如果您需要以字符串的形式输出,可以使用 output() 函数获取渲染的 PDF,因此可以直接通过电子邮件发送,例如。

配置

默认配置设置在 config/pdflayer.php 中设置。将此文件复制到您自己的配置目录以修改值。您可以使用以下 shell 命令发布配置:

php artisan vendor:publish --provider="MathieuTu\PDFLayer\PDFLayerServiceProvider"

许可和感谢

Laravel 的 PDFLayer 桥接器是一个开源软件,根据 MIT 许可证 许可。

开发人员与 pdflayer.com 服务没有任何关联。

此 Readme 和 PDF 类的一些方法来自 barryvdh/laravel-dompdf 包。感谢他的工作。

贡献

问题和 PR 显然受到欢迎和鼓励,无论是新功能还是文档。添加的每一块代码都应该经过彻底测试,但我们可以一起完成这项工作,所以请不要害怕。