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。
• 像使用任何Yii小部件一样使用扩展，通过使用具有最小配置的render方法。
• 扩展使用了mPDF库的最新开发版本（v6.0beta）。它使用packagist上的kartik-v/mpdf存储库作为此最新版本的来源。mPDF 6.0可以利用OpenType布局表来显示复杂的脚本。此版本（v6.0）包含字体（开源），几乎可以覆盖所有可想象的脚本/语言。包括对阿拉伯语或印度语脚本（以及高棉语、老挝语、缅甸语等）的支持。它还预计将改善泰语、越南语和希伯来语的显示。它还包括中文、日文和韩文的附加字体。
• 与yii2-grid扩展内置集成，允许您将网格导出为PDF，甚至生成高级PDF报告。

演示

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

安装

安装此扩展的首选方式是通过composer。

注意：请检查此扩展的需求和依赖项，查看composer.json。阅读关于设置应用程序 composer.json 中的 minimum-stability 设置的网络提示/wiki。

运行以下操作之一

$ 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/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。