Class Tecnick

PDF renderer based on the Tecnick PDF library version 5.8.

The TCPDF library internally changes the multi-byte character strings extension internal encoding to ASCII during the lifetime of a TCPDF object. Therefore several character sets may not work correctly until all instances of this class have their destructors called.

TCPDF

Core\PDF\Tecnick

Namespace: Core\PDF
Package: Core\PDF\Tecnick
Since: 3.0
Requires: PHP 5.3
Version: 1.0
Located at PDF/Tecnick.inc.php

Methods summary

`public`	# `__construct( string $orientation = self::PortraitOrientation, string $unit = self::MillimetersUnit, string $paperFormat = self::IsoA4Paper, boolean $diskCache = false )` Initialises a new Tecnick PDF renderer instance. Header and footer are disabled per default. Initialises a new Tecnick PDF renderer instance. Header and footer are disabled per default. Parameters `$orientation` Page orientation. `$unit` Default unit used for sizes. `$paperFormat` Paper size format. `$diskCache` If set to `true`, contents will be cached on disk to reduce memory footprint. Since 3.0
`public`	# `__destruct( )` Cleans up temporary files and other allocated resources. Cleans up temporary files and other allocated resources. Since 3.0
`public`	# `cellAutoTruncate( integer\|float $width, integer\|float $height = 0, string $text = '', mixed $borderFormat = 0, integer $lineBreak = 0, string $align = '', boolean $fill = false, mixed $link = '', integer $characterStretch = 0, boolean $ignoreMinHeight = false, string $truncationMarker = '...' )` Adds a single-line text cell to the document that is automatically truncated if the contents exceed the given cell width. Adds a single-line text cell to the document that is automatically truncated if the contents exceed the given cell width. Parameters `$width` Cell width. See TCPDF cell() method for details. `$height` Cell height. See TCPDF cell() method for details. `$text` Text to add to document. `$borderFormat` Border format. See TCPDF cell() method for details. `$lineBreak` Controls whether the document position is changed to a new line (1), new line and moved to the bottom of the last position (2) or left unchanged at the end of the box (w.r.t. the language direction). See TCPDF cell() method for details. `$align` Single character to control text alignment: Left, Right, Centered or Justified. See TCPDF cell() method for details. `$fill` If set to `true`, the background is filled, otherwise left transparent. `$link` Link URL or resource identifier. `$characterStretch` Character stretch mode. See TCPDF cell() method for details. `$ignoreMinHeight` Whether to ignore automatic minimum height value. See TCPDF cell() method for details. `$truncationMarker` Truncation marker to append to truncated string. Since 3.0
`protected float`	# `contentWidth( )` Returns the width of the content area of the page. Returns the width of the content area of the page. Returns float Since 3.0
`public`	# `error( string $message )` Replaces the standard TCPDF die() call by a more dynamic exception. This also enables the use of backtraces and exception handlers. Note that for debugging purposes, the changed implementation does not reset the TCPDF internal variables (which would be lost otherwise). Replaces the standard TCPDF die() call by a more dynamic exception. This also enables the use of backtraces and exception handlers. Note that for debugging purposes, the changed implementation does not reset the TCPDF internal variables (which would be lost otherwise). Parameters `$message` Error message. Throws `Core\Exception\Runtime` Unhandled TCPDF error with embedded error message. Since 3.0
`public`	# `imageFromString( string & $imageData, float\|mixed $x = '', float\|mixed $y = '', float\|integer $width = 0, float\|integer $height = 0, string $type = '', mixed $link = '', string $align = '', mixed $resize = false, integer $dpi = 300, string $pageAlign = '', boolean $isMask = false, mixed $imageMask = false, mixed $border = 0, boolean $fitBox = false, boolean $hidden = false )` Embeds an image from a binary image data string. Embeds an image from a binary image data string. Parameters `$imageData` Binary data of image to embed. `$x` See TCPDF image() method for details. `$y` See TCPDF image() method for details. `$width` See TCPDF image() method for details. `$height` See TCPDF image() method for details. `$type` See TCPDF image() method for details. If not defined, the type of the image is automatically detected. `$link` See TCPDF image() method for details. `$align` See TCPDF image() method for details. `$resize` See TCPDF image() method for details. `$dpi` See TCPDF image() method for details. `$pageAlign` See TCPDF image() method for details. `$isMask` See TCPDF image() method for details. `$imageMask` See TCPDF image() method for details. `$border` See TCPDF image() method for details. `$fitBox` See TCPDF image() method for details. `$hidden` See TCPDF image() method for details. Throws `Core\Exception\InvalidArgument` Failed to detect image type. `Core\Exception\Runtime` Failed to create temporary file. Since 3.0
`public string`	# `producer( )` Returns the PDF producer name that is automatically set. Returns the PDF producer name that is automatically set. Returns string Since 3.0
`public`	# `rectTo( float $width, float $height, string $style = '', array $borderStyle = array (), array $fillColor = array () )` Draws a rectangle, starting from the current internal pointer position. Draws a rectangle, starting from the current internal pointer position. Parameters `$width` See TCPDF rect() method for details. `$height` See TCPDF rect() method for details. `$style` See TCPDF rect() method for details. `$borderStyle` See TCPDF rect() method for details. `$fillColor` See TCPDF rect() method for details. Since 3.0
`protected float`	# `remainingWidth( )` Returns the remaining width of the content area of the page. Returns the remaining width of the content area of the page. Returns float Since 3.0
`public`	# `roundedRectTo( float $width, float $height, float $radius, string $roundedCorners = '1111', string $style = '', array $borderStyle = array (), array $fillColor = array () )` Draws a rounded rectangle, starting from the current internal pointer position. Draws a rounded rectangle, starting from the current internal pointer position. Parameters `$width` See TCPDF roundedRect() method for details. `$height` See TCPDF roundedRect() method for details. `$radius` See TCPDF roundedRect() method for details. `$roundedCorners` See TCPDF roundedRect() method for details. `$style` See TCPDF roundedRect() method for details. `$borderStyle` See TCPDF roundedRect() method for details. `$fillColor` See TCPDF roundedRect() method for details. Since 3.0
`public`	# `setPageFormat( mixed $format, string $orientation = self::PortraitOrientation )` Sets the page format and orientation. Sets the page format and orientation. Parameters `$format` Page format identifier string or associative array of format properties. `$orientation` Page orientation. Since 3.0

Constants summary

`string`	`Iso4A0Paper` ISO 4A0 paper size. ISO 4A0 paper size. Since 3.0	# `'4A0'`
`string`	`Iso2A0Paper` ISO 2A0 paper size. ISO 2A0 paper size. Since 3.0	# `'2A0'`
`string`	`IsoA0Paper` ISO A0 paper size. ISO A0 paper size. Since 3.0	# `'A0'`
`string`	`IsoA1Paper` ISO A1 paper size. ISO A1 paper size. Since 3.0	# `'A1'`
`string`	`IsoA2Paper` ISO A2 paper size. ISO A2 paper size. Since 3.0	# `'A2'`
`string`	`IsoA3Paper` ISO A3 paper size. ISO A3 paper size. Since 3.0	# `'A3'`
`string`	`IsoA4Paper` ISO A4 paper size. ISO A4 paper size. Since 3.0	# `'A4'`
`string`	`IsoA5Paper` ISO A5 paper size. ISO A5 paper size. Since 3.0	# `'A5'`
`string`	`IsoA6Paper` ISO A6 paper size. ISO A6 paper size. Since 3.0	# `'A6'`
`string`	`IsoA7Paper` ISO A7 paper size. ISO A7 paper size. Since 3.0	# `'A7'`
`string`	`IsoA8Paper` ISO A8 paper size. ISO A8 paper size. Since 3.0	# `'A8'`
`string`	`IsoA9Paper` ISO A9 paper size. ISO A9 paper size. Since 3.0	# `'A9'`
`string`	`IsoA10Paper` ISO A10 paper size. ISO A10 paper size. Since 3.0	# `'A10'`
`string`	`IsoB0Paper` ISO B0 paper size. ISO B0 paper size. Since 3.0	# `'B0'`
`string`	`IsoB1Paper` ISO B1 paper size. ISO B1 paper size. Since 3.0	# `'B1'`
`string`	`IsoB2Paper` ISO B2 paper size. ISO B2 paper size. Since 3.0	# `'B2'`
`string`	`IsoB3Paper` ISO B3 paper size. ISO B3 paper size. Since 3.0	# `'B3'`
`string`	`IsoB4Paper` ISO B4 paper size. ISO B4 paper size. Since 3.0	# `'B4'`
`string`	`IsoB5Paper` ISO B5 paper size. ISO B5 paper size. Since 3.0	# `'B5'`
`string`	`IsoB6Paper` ISO B6 paper size. ISO B6 paper size. Since 3.0	# `'B6'`
`string`	`IsoB7Paper` ISO B7 paper size. ISO B7 paper size. Since 3.0	# `'B7'`
`string`	`IsoB8Paper` ISO B8 paper size. ISO B8 paper size. Since 3.0	# `'B8'`
`string`	`IsoB9Paper` ISO B9 paper size. ISO B9 paper size. Since 3.0	# `'B9'`
`string`	`IsoB10Paper` ISO B10 paper size. ISO B10 paper size. Since 3.0	# `'B10'`
`string`	`IsoC0Paper` ISO C0 paper size. ISO C0 paper size. Since 3.0	# `'C0'`
`string`	`IsoC1Paper` ISO C1 paper size. ISO C1 paper size. Since 3.0	# `'C1'`
`string`	`IsoC2Paper` ISO C2 paper size. ISO C2 paper size. Since 3.0	# `'C2'`
`string`	`IsoC3Paper` ISO C3 paper size. ISO C3 paper size. Since 3.0	# `'C3'`
`string`	`IsoC4Paper` ISO C4 paper size. ISO C4 paper size. Since 3.0	# `'C4'`
`string`	`IsoC5Paper` ISO C5 paper size. ISO C5 paper size. Since 3.0	# `'C5'`
`string`	`IsoC6Paper` ISO C6 paper size. ISO C6 paper size. Since 3.0	# `'C6'`
`string`	`IsoC7Paper` ISO C7 paper size. ISO C7 paper size. Since 3.0	# `'C7'`
`string`	`IsoC8Paper` ISO C8 paper size. ISO C8 paper size. Since 3.0	# `'C8'`
`string`	`IsoC9Paper` ISO C9 paper size. ISO C9 paper size. Since 3.0	# `'C9'`
`string`	`IsoC10Paper` ISO C10 paper size. ISO C10 paper size. Since 3.0	# `'C10'`
`string`	`IsoRA0Paper` ISO RA0 paper size. ISO RA0 paper size. Since 3.0	# `'RA0'`
`string`	`IsoRA1Paper` ISO RA1 paper size. ISO RA1 paper size. Since 3.0	# `'RA1'`
`string`	`IsoRA2Paper` ISO RA2 paper size. ISO RA2 paper size. Since 3.0	# `'RA2'`
`string`	`IsoRA3Paper` ISO RA3 paper size. ISO RA3 paper size. Since 3.0	# `'RA3'`
`string`	`IsoRA4Paper` ISO RA4 paper size. ISO RA4 paper size. Since 3.0	# `'RA4'`
`string`	`IsoSRA0Paper` ISO SRA0 paper size. ISO SRA0 paper size. Since 3.0	# `'SRA0'`
`string`	`IsoSRA1Paper` ISO SRA1 paper size. ISO SRA1 paper size. Since 3.0	# `'SRA1'`
`string`	`IsoSRA2Paper` ISO SRA2 paper size. ISO SRA2 paper size. Since 3.0	# `'SRA2'`
`string`	`IsoSRA3Paper` ISO SRA3 paper size. ISO SRA3 paper size. Since 3.0	# `'SRA3'`
`string`	`IsoSRA4Paper` ISO SRA4 paper size. ISO SRA4 paper size. Since 3.0	# `'SRA4'`
`string`	`JisB0Paper` JIS B0 paper size. JIS B0 paper size. Since 3.0	# `'JB0'`
`string`	`JisB1Paper` JIS B1 paper size. JIS B1 paper size. Since 3.0	# `'JB1'`
`string`	`JisB2Paper` JIS B2 paper size. JIS B2 paper size. Since 3.0	# `'JB2'`
`string`	`JisB3Paper` JIS B3 paper size. JIS B3 paper size. Since 3.0	# `'JB3'`
`string`	`JisB4Paper` JIS B4 paper size. JIS B4 paper size. Since 3.0	# `'JB4'`
`string`	`JisB5Paper` JIS B5 paper size. JIS B5 paper size. Since 3.0	# `'JB5'`
`string`	`JisB6Paper` JIS B6 paper size. JIS B6 paper size. Since 3.0	# `'JB6'`
`string`	`JisB7Paper` JIS B7 paper size. JIS B7 paper size. Since 3.0	# `'JB7'`
`string`	`JisB8Paper` JIS B8 paper size. JIS B8 paper size. Since 3.0	# `'JB8'`
`string`	`JisB9Paper` JIS B9 paper size. JIS B9 paper size. Since 3.0	# `'JB9'`
`string`	`JisB10Paper` JIS B10 paper size. JIS B10 paper size. Since 3.0	# `'JB10'`
`string`	`Kai8Paper` KAI 8 paper size. KAI 8 paper size. Since 3.0	# `'KAI8'`
`string`	`Kai16Paper` KAI 16 paper size. KAI 16 paper size. Since 3.0	# `'KAI16'`
`string`	`Kai32Paper` KAI 32 paper size. KAI 32 paper size. Since 3.0	# `'KAI32'`
`string`	`Kai32BigPaper` KAI 32 Big paper size. KAI 32 Big paper size. Since 3.0	# `'KAI32B'`
`string`	`USLetterPaper` US Letter paper size. US Letter paper size. Since 3.0	# `'LETTER'`
`string`	`USLegalPaper` US Legal paper size. US Legal paper size. Since 3.0	# `'LEGAL'`
`string`	`USExecutivePaper` US Executive paper size. US Executive paper size. Since 3.0	# `'EXECUTIVE'`
`string`	`USFolioPaper` US Folio paper size. US Folio paper size. Since 3.0	# `'FOLIO'`
`string`	`PointsUnit` Points unit symbol. Points unit symbol. Since 3.0	# `'pt'`
`string`	`MillimetersUnit` Millimeters unit symbol. Millimeters unit symbol. Since 3.0	# `'mm'`
`string`	`CentimetersUnit` Centimeters unit symbol. Centimeters unit symbol. Since 3.0	# `'cm'`
`string`	`InchesUnit` Inches unit symbol. Inches unit symbol. Since 3.0	# `'in'`
`string`	`PortraitOrientation` Portrait page orientation. Portrait page orientation. Since 3.0	# `'P'`
`string`	`LandscapeOrientation` Landscape page orientation. Landscape page orientation. Since 3.0	# `'L'`

Namespaces

Classes

Class Tecnick

Methods summary

Parameters

Since

Since

Parameters

Since

Returns

Since

Parameters

Throws

Since

Parameters

Throws

Since

Returns

Since

Parameters

Since

Returns

Since

Parameters

Since

Parameters

Since

Constants summary

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since