README

yii2-mpdf

yii2-mpdf 扩展是mPDF库的增强版包装组件，该库可以从UTF-8编码的HTML生成PDF文件。mPDF库基于FPDF和HTML2FPDF，具有多项增强功能。库的关键特性是能够从HTML内容动态生成PDF文件，并支持多种语言。请参考文档手册或上游mpdf网站以了解库的更多详情和用法。yii2-mpdf扩展提供了一种简单的方法，将mPDF库集成到您的Yii应用程序中，并进行了细微的增强。本版本提供的主要功能包括

在您的yii应用程序配置中全局设置 pdf 组件。
使用简单的数组配置轻松设置mPDF属性或调用mPDF方法。
增强扩展以设置自定义CSS文件以渲染格式化的HTML内容。
扩展内置了bootstrap.css（v3.3.0已修改以适用于mPDF），默认应用。这将使您能够轻松地从bootstrap标记HTML生成PDF内容。
提供将内联CSS附加到您自己的CSS文件中的简便方法。
提供简单易用的面向对象方法来渲染复杂的PDF。
通过使用最少配置的渲染方法，像使用任何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 的提示，请阅读此网络提示 /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 文件。

hessianz / yii2-mpdf

维护者

详情