guidofaecke/dompdf-module

一个用于集成DOMPDF支持的Laminas模块 - 原创者为Raymond Kolbe

0.8.0 2023-05-16 18:58 UTC

This package is not auto-updated.

Last update: 2024-10-02 23:45:13 UTC


README

DOMPDF模块通过最小化消费者端的努力,将DOMPDF库与Laminas集成。

要求

安装

DOMPDFModule的安装使用PHP Composer。有关PHP Composer的更多信息,请访问官方网站 PHP Composer

安装步骤

  1. cd my/project/directory

  2. 通过以下方式将模块添加到项目中:

    composer require guidofaecke/dompdf-module

  3. 打开 my/project/directory/config/application.config.php 并将以下键添加到您的 modules

    'DOMPDFModule',

配置选项

您可以通过本地或全局配置文件中的 dompdf_module 键覆盖选项。有关配置选项,请参阅 DOMPDFModule/config/module.config.php。

用法

<?php

namespace Application\Controller;

use Laminas\Mvc\Controller\AbstractActionController;
use DOMPDFModule\View\Model\PdfModel;

class ReportController extends AbstractActionController
{
    public function monthlyReportPdfAction()
    {
        $pdf = new PdfModel();
        $pdf->setOption('fileName', 'monthly-report');            // "pdf" extension is automatically appended
        $pdf->setOption('display', PdfModel::DISPLAY_ATTACHMENT); // Triggers browser to prompt "save as" dialog
        $pdf->setOption('paperSize', 'a4');                       // Defaults to "8x11"
        $pdf->setOption('paperOrientation', 'landscape');         // Defaults to "portrait"
        
        // To set view variables
        $pdf->setVariables(array(
          'message' => 'Hello'
        ));
        
        return $pdf;
    }
}

开发

您想贡献?太棒了!不用担心,这很简单。本地构建、测试和代码质量检查可以使用 Docker 执行。

快速入门

  1. 安装 Docker CE
  2. 从您的终端运行以下命令
docker build -t guidofaecke/dompdf-module .
docker run -v composer-cache:/var/lib/composer -v ${PWD}:/opt/app guidofaecke/dompdf-module

很简单,对吧?下面是一个快速浏览,了解正在发生什么。

  • docker build -t guidofaecke/dompdf-module . 构建一个用于每次运行(即每次执行 docker run)的Docker镜像,并将其标记为 guidofaecke/dompdf-module
  • docker run -v composer-cache:/var/lib/composer -v ${PWD}:/opt/app guidofaecke/dompdf-module 在从标记为 guidofaecke/dompdf-module 的镜像派生的新的Docker容器中运行默认构建。项目根目录和PHP Composer缓存卷被挂载,以便在构建过程中生成的工件可在您的本地机器上可用。

注意: 您只需运行第一次命令一次以构建镜像。第二次命令是执行构建(构建、测试、代码质量检查等)的命令。