https://github.com/heimrichhannot/pdf-creator

PdfCreator is a high level API for PDF file creating with PHP.
https://github.com/heimrichhannot/pdf-creator

Last synced: about 1 month ago
JSON representation

PdfCreator is a high level API for PDF file creating with PHP.

• Host: GitHub
• URL: https://github.com/heimrichhannot/pdf-creator
• Owner: heimrichhannot
• License: other
• Created: 2021-02-15T14:43:15.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-01T12:29:43.000Z (5 months ago)
• Last Synced: 2024-11-05T14:53:26.033Z (about 2 months ago)
• Language: PHP
• Size: 173 KB
• Stars: 1
• Watchers: 7
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# PDF Creator

PdfCreator is a high level API for PDF file creating with PHP. Its goal is to make usage of existing libraries easier and object-orientated.

## Features

- supported libraries:

  - [Dompdf](https://github.com/dompdf/dompdf)

  - [mPDF](https://github.com/mpdf/mpdf)

  - [TCPDF](https://github.com/tecnickcom/TCPDF)

## Example

```php

use HeimrichHannot\PdfCreator\Concrete\MpdfCreator;

use HeimrichHannot\PdfCreator\PdfCreatorFactory;

$pdf = PdfCreatorFactory::createInstance(MpdfCreator::getType());

$pdf->setHtmlContent($this->compile())

    ->setFilename($this->getFileName())

    ->setFormat('A4')

    ->setOrientation($pdf::ORIENTATION_PORTRAIT)

    ->addFont(

        "/path_to_project/assets/fonts/my_great_font.tff", 

        "myGreatFont", 

        $pdf::FONT_STYLE_REGUALAR,

        "normal"

    )

    ->setMargins(15, 10, 15,10)

    ->setTemplateFilePath("/path_to_project/assets/pdf/mastertemplate.pdf")

    ->setOutputMode($pdf::OUTPUT_MODE_DOWNLOAD)

    ->render()

;

```

## Usage

### Install

We recommend installing this library with composer:

    composer require heimrichhannot/pdf-creator

You also need to install the pdf library, you want to use this bundle with:

- Dompdf (version 1 to 3 are supported):

  - `"dompdf/dompdf": "^3.0"`

  - if you want to use master templates in Dompdf, you also need FPDI and TCPDF:    

    - `"tecnickcom/tcpdf": "^6.3"`

    - `"setasign/fpdi": "^2.3"`

- mPDF (version 7 and 8 are supported):

  - `"mpdf/mpdf": "^8.0"`

- TCPDF

  - `"tecnickcom/tcpdf": "^6.3"`

  - if you want to use master templates in TCPDF, you also need FPDI:    

    - `"setasign/fpdi": "^2.3"`

If you're using [Contao](https://contao.org/), you could try the [PDF Creator Bundle](https://github.com/heimrichhannot/contao-pdf-creator-bundle), which is based on this library.

### Use callback for custom adjustments

Due the high level approach not all specific library functionality could be supported. To add specific configuration, you can use the callback mechanism comes with this api.

Callback | Description

-------- | -----------

BeforeCreateLibraryInstanceCallback | Is evaluated before the library instance is created and allows to modifiy the constructor parameters.

BeforeOutputPdfCallback | Is evaluated before the library method to output the pdf is called and provide the library instance and the output method parameters.

```php

use HeimrichHannot\PdfCreator\BeforeCreateLibraryInstanceCallback;

use HeimrichHannot\PdfCreator\BeforeOutputPdfCallback;

use HeimrichHannot\PdfCreator\Concrete\MpdfCreator;

use HeimrichHannot\PdfCreator\PdfCreatorFactory;

$pdf = PdfCreatorFactory::createInstance(MpdfCreator::getType());

$pdf->setBeforeCreateInstanceCallback(function (BeforeCreateLibraryInstanceCallback $callbackData) {

    $parameter = $callbackData->getConstructorParameters();

    $parameter['config']['fonttrans'] = [

        'rotis-sans-serif-w01-bold' => 'rotis-sans-serif',

        'rotissansserifw01-bold' => 'rotis-sans-serif',

    ];

    $callbackData->setConstructorParameters($parameter);

    return $callbackData;

});

$pdf->setBeforeOutputPdfCallback(function (BeforeOutputPdfCallback $callbackData) use ($pdf) {

    $mpdf = $callbackData->getLibraryInstance();

    $mpdf->AddPage();

    $parameters = $callbackData->getOutputParameters();

    $parameters['name'] = 'custom_'.$pdf->getFilename();

    $callbackData->setOutputParameters($parameters);

});

```

### Use return value

The render method return an `PdfCreatorResult` instance. It contains the output 

mode and filepath or filecontent for corresponding output modes.

```php

use HeimrichHannot\PdfCreator\Concrete\DompdfCreator;

use HeimrichHannot\PdfCreator\PdfCreatorFactory;

$pdf = PdfCreatorFactory::createInstance(DompdfCreator::getType());

$result = $pdf->setOutputMode($pdf::OUTPUT_MODE_FILE)

    // ...

    ->render()

;

$filepath = $result->getFilePath();

$pdf = PdfCreatorFactory::createInstance(DompdfCreator::getType());

$result = $pdf->setOutputMode($pdf::OUTPUT_MODE_STRING)

    // ...

    ->render()

;

$filepath = $result->getFileContent();

```

## Documentation

- [API Documentation](https://heimrichhannot.github.io/pdf-creator/)