README

This bundle adds a generic way to configure the creation of pdf files, reuse these configurations and create pdfs on base of them. It's based on PDF Creator library.

Features

• add PDF configurations from backend module or yaml
• can be easily used in your bundle
• bundled support for:
  • contao article syndication
  • Syndication Type Bundle

Note: there is no pdf library bundled with this bundle, you need to add the ones you want to use by your own! See Usage section for more information.

Screenshot Configuration

Usage

Setup

1. Install the pdf library you want to use (currently dompdf, mpdf and tcpdf are supported, see PDF Creator library) for more information

2. Install bundle with composer or contao manager

    composer require heimrichhannot/contao-pdf-creator-bundle
   

3. Update database

4. Create a pdf configuration in contao backend within system -> pdf configuration or via yaml (see configuration reference)

Yaml pdf configuration

To reuse configurations or customize them on different environments, you can set pdf creator configs in your configuration files. You'll find all possible options in the configuration reference.

Example:

# /config/config.yml
huh_pdf_creator:
  configurations:
    news_export:
      type: dompdf
      name: "Default News export configuration"
      filename: '%%title%%-my_brand_corporate.pdf'
      output_mode: inline
    brand_brochure:
      type: dompdf
      name: "Brand brochure"
      filename: 'my_brand_corporate.pdf'
      output_mode: download
      format: A5
      base_template: 'files/media/brand_cd/brand_brochure_template.pdf'

Export article as pdf

1. Set huh_pdf_creator.enable_contao_article_pdf_syndication to true

   # config/config.yml or app/config/config.yml (Contao 4.4)
   huh_pdf_creator:
       enable_contao_article_pdf_syndication: true

2. Clear cache and update database

3. Choose pdf as syndication option in article configuration and select a pdf configuration

Syndication Bundle

Select PDF syndication and choose the pdf creator setting you want for export.

Advanced topics

Logging

To get enhanced debug information while creating pdfs, you can enter the contao dev mode. In dev mode, pdf creator bundle save all logs created by the pdf library (if the library supports PSR-3 logging) to a huh_pdf_creator-[DATE].log file in the log folder. For dompdf this bundle support the custom logging implementation and stores the log to a huh_pdf_creator-dompdf.log file in the log folder.

Server routing issues / authentication

To avoid trouble with server routing (special url handling with docker etc.) and use the library on access restricted websites (for example staging setups), you can set a base_url that will override the url determined from the request and credentials (http basic authentication is supported only). These options are only available with yaml configuration as they usually server-specific.

huh_pdf_creator:
  configurations:
    custom_pdf_config:
      type: dompdf
      name: "PDF behind authentication"
      base_url: 'https://customer.example.org'
      credentials: 'user:password'

DomPdf chroot setting

Pdf Creator Bundle comes with default settings for dompdf chroot option for the most typical folders where files are stored, that are used in pdfs. You can adjust this settings in the bundle configuration.

These are the default settings:

huh_pdf_creator:
    allowed_paths:
        - web
        - public
        - files
        - assets

Developer

Add pdf creator to your bundle

1. Use PdfGenerator::generate() to generate a pdf with your content. It expects an id of an PDF Creator config, html content and an PdfContext instance and returns a PdfCreatorResult instance.

   use Heimrichhannot\PdfCreatorBundle\Generator\PdfGenerator;
   use Heimrichhannot\PdfCreatorBundle\Generator\PdfGeneratorContext;
   
   class ExportCustomEntity {
       /**@var PdfGenerator */
       protected $pdfGenerator;
       
       public function __invoke(string $content, array $row): void {
           $context = new PdfGeneratorContext($row['title']);
           $result = $this->pdfGenerator->generate($content, $row['pdfConfiguration'], $context);
           
       }
   }

2. Use DcaGenerator to add an PDF Creator config field to your dca.

   use Contao\CoreBundle\DataContainer\PaletteManipulator;
   use Heimrichhannot\PdfCreatorBundle\Generator\DcaGenerator;
   
   class LoadDataContainerListener {
       /** @var DcaGenerator */
       protected $dcaGenerator;
       
       public function __invoke(string $table): void
       {
           if ('tl_custom_dca' === $table) {
               PaletteManipulator::create()->addField('pdfConfiguration', 'someField')->applyToPalette('default', 'tl_custom_entity');
               $GLOBALS['TL_DCA']['tl_custom_entity']['fields']['pdfConfiguration'] = $this->dcaGenerator->getPdfCreatorConfigSelectFieldConfig();
           }
       }
   }

Events

More information

Configuration reference