Generator\TcPdf

Generates PDF files using TCPDF. The subpart ###TEMPLATE_PDF### is required by this component! In this subpart you can adjust the PDF ouput using HTML.

Version added

1.0.0

Example code

... {
  class = Generator\TcPdf
  config {
    storeInTempFile = 1
    checkBinaryCrLf = lastname,firstname
    returnFileName = 1
  }
}

Properties

.templateFile

Path to template file or template code

Data type

String / cObj

Version added

1.0.0

.storeInTempFile

If set, the generator will save the output in a temporary file rather than sending it directly as content.
Required if you are using Finisher_Mail in combination with returnFileName.

Data type

Integer (0,1,2)

Version added

1.0.0

.outputFileName

If set, the generator will use this file name for the generated file.

Data type

String | cObj

Default value

formhandler.pdf

Version added

2.0.0

Example code

outputFileName = formhandler-export.pdf

.checkBinaryCrLf

Line breaks in the values of the entered fields will be replaced with HTML break tags.

Data type

String

Version added

1.0.0

.returnFileName

If set, the generator will only return the file name of the generated PDF.
Required if you are using Finisher_Mail in combination with storeInTempFile.

Data type

Integer (0,1,2)

Version added

1.0.0

.linkText

The text of the link

Data type

String | cObj

Default value

Save

Version added

1.0.0

.linkTarget

Data type

String | cObj

Default value

_self

Version added

2.4.0

.footerText

The text to insert at the bottom of each PDF page. If this parameter is set, the standard footer text will not be inserted. You can use two special markers in the text:
###PDF_PAGE_NUMBER### inserts the current page number.
###PDF_TOTAL_PAGES### inserts the total page count

Data type

String | cObj

Version added

1.0.0

.headerText

The text to insert at the top of each PDF page. See footerText for a list of special markers.

Data type

String | cObj

Version added

1.0.0

.customTempOutputPath

Specify a custom path where to store the generated files

Data type

String

Default value

typo3temp

Version added

1.0.0

.additionalParams

Array of additional parameters to be set in the generation link URL.

Data type

Array

Version added

1.4.0

Example code

additionalParams {
  param1 = TEXT
  param1.value = myValue
}