Fluid-FPDF for TYPO3

This extension provides you a complete set of ViewHelpers for dealing with FPDF by using Fluid. You can use the ViewHelpers easily in own Extensions just by defining the fpdf-Namespace. Additionally you're able to use the build in plugin, for displaying predefined PDF. This plugin offers you automatically all available PDFs.

Features:

• Fluid-ViewHelper for all FPDF-Functions
• Usable in own Extensions
• Predefine PDFs by using Fluid-Templates and provide them to your page-editors

ViewHelpers

fpdf:addFont

Imports a TrueType, OpenType or Type1 font and makes it available. It is necessary to generate a font definition file first with the MakeFont utility. The definition file (and the font file itself when embedding) must be present in the font directory. If it is not found, the error "Could not include font definition file" is raised.

Parameter

Return

void

Usage:

<fpdf:setFont family="Arial" style="B" size="10.5" />

fpdf:pdf

Creates a new PDF.

Parameter

Return

void

Usage:

<fpdf:pdf>
    <fpdf:addPage orientation="P" size="A4">
        // Your PDF content...
    </fpdf:addPage>
</fpdf:pdf>

fpdf:setFont

Sets the font used to print character strings.

Parameter

Return

void

Usage:

<fpdf:setFont family="Arial" style="B" size="10.5" />

fpdf:setSourceFile

Set the source file for PDF page templates.

Parameter

Return

int - Number of pages found in source file

Usage:

<fpdf:setSourceFile file="EXT:fluid_fpdf/Resources/Private/Pdf/Normbriefbogen_DIN5008.pdf" />

fpdf:useTemplate

Prints a PDF-Template into a page

Parameter

Return

void

Usage:

<fpdf:useTemplate pageNo="1" x="0" y="0" w="0" h="0" adjustPageSize="0" />

Frequently asked questions (FAQ)

How to set an background PDF

Just use the fpdf:useTemplate-ViewHelper, for example:

<fpdf:pdf>
    <fpdf:addPage orientation="P" size="A4">
        <fpdf:setSourceFile file="EXT:fluid_fpdf/Resources/Private/Pdf/Normbriefbogen_DIN5008.pdf" />
        <fpdf:useTemplate pageNo="1" x="0" y="0" /> 
        <f:comment>
            // Your PDF content...
        </f:comment>
    </fpdf:addPage>
</fpdf:pdf>

How to use your own fonts in PDF

For using your own fonts in Fluid-FPDF, you need to convert the fonts into a special format.

The FPDF-Website supports a small Converting-Tool: http://www.fpdf.org/makefont/

Just choose your TTF-File and select the required encoding (for example ISO-8859-15). The result are two files - one php-File and one z-File.

For example, you want to convert the Ubunut-Font which is available on Google-Webfonts. You need the regular and bold font. Downloaded you receive the following files:

• Ubuntu-Regular.ttf
• Ubuntu-Bold.ttf

Once converted, you have these files:

• Ubuntu-Regular.php
• Ubuntu-Regular.z
• Ubuntu-Bold.php
• Ubuntu-Bold.z

Follow the next steps, in order to use the font:

1. Upload these two file into your TYPO3-Installation
2. Define the new Fontpath in fpdf:pdf
3. Add fonts with the fpdf:addFont
4. Set the required font
5. Write your text

<fpdf:pdf fontPath="EXT:theme_bootstrap4/Resources/Private/Fonts">
    <!-- Add required Fonts -->
    <fpdf:addFont family="Ubuntu" style="N" filename="Ubuntu-Regular.php" />
    <fpdf:addFont family="Ubuntu" style="B" filename="Ubuntu-Bold.php" />
    <fpdf:addPage orientation="P" size="A4">
        <!-- Set font -->
        <fpdf:setFont family="Ubuntu" style="N" size="12" />
        <!-- Write your text -->
        <fpdf:multiCell width="100" height="5" text="Hello world" />
        <f:comment>
            // Your PDF content...
        </f:comment>
    </fpdf:addPage>
</fpdf:pdf>

Notice:

You need some support by converting your font? Get in contact with us: typo3(at)coding(dot)ms

A character of my font isn't displayed well in PDF (for example the €-character) - what to do?

First create a character dump of the string, in order to identify which characters are used:

<fpdf:debug.stringCharacterDump string="1.20 €" />

The result should look like this:

1 : 49
. : 46
2 : 50
0 : 48
 : 32
? : 63
 : 0

Now you know, your €-character is placed by the character with ASCII-No. 63.

In the next step, you perform a font dump with the font you want to use:

<fpdf:debug.fontDump />

I our example, the character on number 63 is displayed as ? - that's not what we expect. Take a closer look on your font dump and search for the €-character. We found it on ASCII-No. 162.

How to add a missing € character to a font

1. Open Font with FontForge
2. Menu -> View -> Goto -> search for 'Euro'
3. Copy character 8364
4. Select character 128 and paste the copied € character
5. Menu -> Encoding -> Reencode -> ISO 8859-1
6. Select character 128 -> right click on 'Glyph Info' -> enter 'Euro' in 'Glyph Name' and press 'Set From Name'
7. Menu -> File -> Generate Fonts -> save as .ttf

Attention: While generating the FPDF font with makefont, select cp1250!

Perform the same actions for adding a bullet:

1. Menu -> View -> Goto -> search for 'Bullet'
2. Copy character 8226
3. Select character 149 and paste the copied character
4. Select character 128 -> right click on 'Glyph Info' -> enter 'bullet' in 'Glyph Name' and press 'Set From Name'

FAQ

How to write a PDF template, which returns the PDF as string?

This is useful, if you like to attach the created PDF to a mail or something else.

<html xmlns:f="http://typo3.org/ns/TYPO3/CMS/Fluid/ViewHelpers"
      xmlns:fpdf="http://typo3.org/ns/CodingMs/FluidFpdf/ViewHelpers"
      data-namespace-typo3-fluid="true"><f:spaceless>
<f:format.raw>
    <fpdf:pdf destination="S">
        <fpdf:addPage orientation="P" size="A4">
            <fpdf:setFont family="Arial" style="B" size="10" />
            <fpdf:text x="10" y="10" text="Hello Pdf-World" />
            <fpdf:setXY x="40" y="40" />
            <fpdf:cell width="40" height="10" text="Hello World!" />
        </fpdf:addPage>
    </fpdf:pdf>
</f:format.raw>
</f:spaceless></html>

The important thing is, that there're no spaces and the PDF-Code is not escaped!

How to pass some variables into the Footer-Template?

First you have to define the Footer-Template and pass the variables by the footerArguments Attribute.

<fpdf:pdf footerTemplate="{template.settings.footer.template}"
          footerArguments="{template.settings}">

    <fpdf:addPage />

</fpdf:pdf>

Afterwards you're able to use it in Footer-Template.

<html xmlns="http://www.w3.org/1999/xhtml" lang="en"
      xmlns:f="http://typo3.org/ns/fluid/ViewHelpers"
      xmlns:fpdf="http://typo3.org/ns/CodingMs/FluidFpdf/ViewHelpers"
      data-namespace-typo3-fluid="true">

    <!-- Page numbers -->
    <fpdf:setFont family="Helvetica" style="{settings.footer.fontStyle}" size="{settings.footer.fontSize}" />

    <fpdf:setXY x="20" y="280" />
    <fpdf:cell width="170" text="{settings.footer.text}" align="L" border="T" height="{settings.footer.lineHeight}" />

    <fpdf:variable.set name="pages" value="Seite {fpdf:pageNo()} von |nb|" />
    <fpdf:cell text="{pages}" align="R" width="43" height="{settings.footer.lineHeight}" />

    <fpdf:setSourceFile file="{settings.backgroundPdf}" />
    <fpdf:useTemplate pageNo="1" x="0" y="0" />

</html>

In our example we have some TypoScript-Configuration, which we pass to the Fluid.

settings {
    backgroundPdf = EXT:fluid_fpdf/Resources/Private/Pdf/Normbriefbogen_DIN5008.pdf
    footer {
        template = EXT:crm/Resources/Private/Templates/Pdf/Footer.html
        text = PDF-Description
        pageNumberPrefix = Seite
        pageNumberDivider = von
        fontSize = 9
        fontStyle = N
        lineHeight = 6
    }
}

Contribution

Every contribution is welcome! Hands on documentation, tutorials, Blog posts, Bug reporting, Bug fixing!

Support