README

yii2-mpdf

yii2-mpdf 扩展是一个增强版的 mPDF库的 Yii2 包装组件。mPDF库提供了从UTF-8编码的HTML生成PDF文件的能力。这个库基于FPDF 和 HTML2FPDF，并增加了一些功能。库中的关键特性包括能够从HTML内容动态生成PDF文件，并支持多种语言。有关库的详细信息和使用说明，请参考文档手册或上游mpdf网站。yii2-mpdf扩展提供了一个简单的方法，在您的Yii应用程序中集成和使用mPDF库，并进行了细微的增强。本版本的关键特性包括

在您的yii应用程序配置中全局设置 pdf 组件。
使用简单的数组配置轻松设置mPDF属性或调用mPDF方法。
增强扩展，以便设置您自己的自定义CSS文件以渲染格式化的HTML内容。
扩展内置了bootstrap.css（v3.3.0修改用于mPDF）的版本，默认应用。这将允许您轻松地从bootstrap标记HTML生成PDF内容。
提供了一种简单的方法，除了您的CSS文件外，还可以预置内联CSS。
提供易于使用的面向对象的方法来渲染复杂的PDF。
通过使用具有最小配置的render方法，像使用任何Yii小部件一样轻松使用扩展。
该扩展使用mPDF库的最新开发版本（v6.0beta）。它使用packagist上的kartik-v/mpdf存储库作为此最新版本的源。mPDF 6.0可以利用OpenType布局表来显示复杂的脚本。此版本（v6.0）包含覆盖几乎所有可想象的脚本/语言的字体（开源）。包括对阿拉伯语或印度语脚本（以及高棉语、老挝语、缅甸语等）的支持。它还预计将改善泰语、越南语和希伯来语的显示。还包括中文、日文和韩文的额外字体。
内置与yii2-grid扩展的集成，允许您将网格导出为PDF，甚至生成高级PDF报告。

演示

阅读扩展的详细文档和用法。

安装

安装此扩展的首选方法是使用composer。

注意：检查此扩展的composer.json以了解其要求和依赖项。阅读有关在您的应用程序的composer.json中设置minimum-stability设置的网络提示/维基。

运行

$ composer require misterspelik/yii2-mpdf "dev-master"

或添加

"misterspelik/yii2-mpdf": "dev-master"

到您的 composer.json 文件的 require 部分。

用法

小部件用法

该组件可以直接以类似于任何小部件的方式使用，将您的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/src/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 文件。

misterspelik / yii2-mpdf

维护者

详细信息