netiul/dompdf-module

A Zend Framework 2 module for incorporating DOMPDF support - Originally by Raymond Kolbe

Saturday, April 30, 2016
by netiul
Repository
3 Watchers
2 Stars
3,600 Installations

PHP
0 Dependents
0 Suggesters
59 Forks
1 Open issues
8 Versions
11 % Grown

The README.md

DOMPDFModule

Master: , _(*1)

The DOMPDF module integrates the DOMPDF library with Laminas with minimal effort on the consumer's end., _(*2)

Requirements

Laminas

Installation

Installation of DOMPDFModule uses PHP Composer. For more information about PHP Composer, please visit the official PHP Composer site., _(*3)

Installation steps

cd my/project/directory
Add the module to the project by:, _(*4)

composer require netiul/dompdf-module, _(*5)
open my/project/directory/config/application.config.php and add the following key to your modules:, _(*6)
```
'DOMPDFModule',
```

Configuration options

You can override options via the dompdf_module key in your local or global config files. See DOMPDFModule/config/module.config.php for config options., _(*7)

Usage

<?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;
    }
}

Development

So you want to contribute? Fantastic! Don't worry, it's easy. Local builds, tests, and code quality checks can be executed using Docker., _(*8)

Quick Start

Install Docker CE.
Run the following from your terminal:

docker build -t dino/dompdf-module .
docker run -v composer-cache:/var/lib/composer -v ${PWD}:/opt/app dino/dompdf-module

Super easy, right? Here's a quick walk through as to what's going on., _(*9)

docker build -t dino/dompdf-module . builds a docker image that will be used for each run (i.e. each time docker run is executed) and tags it with the name dino/dompdf-module.
docker run -v composer-cache:/var/lib/composer -v ${PWD}:/opt/app dino/dompdf-module runs the default build in a new Docker container derived from the image tagged dino/dompdf-module. The root of the project and PHP Composer cache volume are mounted so that artifacts generated during the build process are available to you on your local machine.

Note: You only need to run the first command once in order to build the image. The second command is what executes the build (build, tests, code quality checks, etc.)., _(*10)