wdzulc / yii2-mpdf
一个用于从UTF-8编码的HTML生成PDF文件的mPDF库的Yii2包装组件。
v1.0.3
2017-11-22 00:24 UTC
Requires
- mpdf/mpdf: ~7.0
This package is not auto-updated.
Last update: 2024-09-20 02:32:27 UTC
README
yii2-mpdf 扩展是一个对 mPDF库 的增强包装组件。mPDF库能够从UTF-8编码的HTML生成PDF文件。该库基于 FPDF 和 HTML2FPDF,并进行了许多增强。库的关键特性是可以从HTML内容实时生成PDF文件,并处理多种语言。请参阅文档手册或上游mpdf网站以获取更多关于库的详细信息和理解。yii2-mpdf扩展提供了一个简单的方式来集成和使用mPDF库,并提供了细微的增强。此版本提供的主要特性包括
- 在您的yii应用配置中全局设置
pdf组件。 - 使用简单的数组配置轻松设置mPDF属性或调用mPDF方法。
- 增强扩展以设置用于渲染格式化HTML内容的自定义CSS文件。
- 扩展内置了bootstrap.css(v3.3.0针对mPDF修改)的版本,默认应用。这将允许您轻松地从bootstrap标记HTML生成PDF内容。
- 提供了一种简单的方法,除了自己的CSS文件外,还可以预置内联CSS。
- 提供了一种易于使用的面向对象的方法来渲染复杂的PDF。
- 可以通过使用具有最小配置的render方法,以类似于任何Yii小部件的方式使用扩展。
- 该扩展使用了mPDF库的最新开发版本(v6.0beta)。它使用packagist上的composer存储库
kartik-v/mpdf作为此最新版本的来源。mPDF 6.0可以利用OpenType布局表来显示复杂的脚本。此版本(v6.0)包含(开源)字体,可以覆盖几乎所有可想象的脚本/语言。包括对阿拉伯语或印度语脚本(以及高棉语、老挝语、缅甸语等)的支持。它还预计将改善泰语、越南语和希伯来语的显示。它还包括中文、日文和韩文等额外字体。 - 内置与 yii2-grid 扩展的集成,允许您将网格导出为PDF,甚至生成高级PDF报告。
演示
阅读扩展的详细 文档和用法。
安装
安装此扩展的首选方式是通过 composer。
注意:请检查此扩展的 composer.json 以获取此扩展的需求和依赖。请阅读有关设置应用程序的 web提示/wiki 中的
minimum-stability设置。
运行以下命令之一:
$ php composer.phar require kartik-v/yii2-mpdf "dev-master"
或者将以下内容添加到您的 composer.json 文件的 require 部分:
"kartik-v/yii2-mpdf": "dev-master"
使用
使用
小部件式使用
组件可以像任何小部件一样直接使用,以将HTML内容渲染为PDF。例如,您可以在控制器操作中简单调用组件,如下所示
use kartik\mpdf\Pdf; public function actionReport() { // get your HTML raw content without any layouts or scripts $content = $this->renderPartial('_reportView'); // setup kartik\mpdf\Pdf component $pdf = new Pdf([ // set to use core fonts only 'mode' => Pdf::MODE_CORE, // A4 paper format 'format' => Pdf::FORMAT_A4, // portrait orientation 'orientation' => Pdf::ORIENT_PORTRAIT, // stream to browser inline 'destination' => Pdf::DEST_BROWSER, // your html content input 'content' => $content, // format content from your own css file if needed or use the // enhanced bootstrap css built by Krajee for mPDF formatting 'cssFile' => '@vendor/kartik-v/yii2-mpdf/assets/kv-mpdf-bootstrap.min.css', // any css to be embedded if required 'cssInline' => '.kv-heading-1{font-size:18px}', // set mPDF properties on the fly 'options' => ['title' => 'Krajee Report Title'], // call mPDF methods on the fly 'methods' => [ 'SetHeader'=>['Krajee Report Header'], 'SetFooter'=>['{PAGENO}'], ] ]); // return the pdf output as per the destination setting return $pdf->render(); }
全局组件
您还可以将小部件设置为全局组件,以便在您的应用程序中跨模块使用,并预设默认值。例如,在您的 Yii 应用程序配置文件的组件部分设置以下内容:
use kartik\mpdf\Pdf; // ... 'components' => [ // setup Krajee Pdf component 'pdf' => [ 'class' => Pdf::classname(), 'format' => Pdf::FORMAT_A4, 'orientation' => Pdf::ORIENT_PORTRAIT, 'destination' => Pdf::DEST_BROWSER, // refer settings section for all configuration options ] ]
设置组件后,您可以在应用程序中轻松引用它。
$pdf = Yii::$app->pdf; $pdf->content = $htmlContent; return $pdf->render();
有关其他用法和详细信息,请阅读详细的文档。
许可协议
yii2-mpdf 在 BSD 3-Clause 许可协议下发布。有关详细信息,请参阅捆绑的 LICENSE.md 文件。