FPDI

class FPDI extends FPDF_TPL

Properties

array $tpls Array of Tpl-Data from FPDF_TPL
int $tpl Current Template-ID from FPDF_TPL
boolean $_intpl "In Template"-Flag from FPDF_TPL
string $tplprefix Nameprefix of Templates used in Resources-Dictonary from FPDF_TPL
array $_res Resources used By Templates and Pages from FPDF_TPL
array $lastUsedTemplateData Last used Template data from FPDF_TPL
string $current_filename Actual filename
array $parsers Parser-Objects
object $current_parser Current parser
array $_obj_stack object stack
array $_don_obj_stack done object stack
integer $_current_obj_id Current Object Id.
string $lastUsedPageBox The name of the last imported page box
array $_importedPages Cache for imported pages/template ids

Methods

_putstream($s)

No description

from FPDF
_getxobjectdict()

No description

from FPDF
pdf_write_value(array $value)

Writes a value Needed to rebuild the source document

string
_unescape(string $s)

Unescapes a PDF string

from FPDF
string
hex2str(string $hex)

Hexadecimal to string

from FPDF
string
str2hex(string $str)

String to hexadecimal

from FPDF
int
beginTemplate(int $x = null, int $y = null, int $w = null, int $h = null)

Start a Template

from FPDF_TPL
mixed
endTemplate()

End Template

from FPDF_TPL
useTemplate(int $tplidx, int $_x = null, int $_y = null, int $_w, int $_h, $adjustPageSize = false)

Use a Template in current Page or other Template

array
getTemplateSize(int $tplidx, int $_w, int $_h)

Get The calculated Size of a Template

from FPDF_TPL
SetFont($family, $style = '', $size)

See FPDF/TCPDF-Documentation ;-)

from FPDF_TPL
Image($file, $x = null, $y = null, $w, $h, $type = '', $link = '')

See FPDF/TCPDF-Documentation ;-)

from FPDF_TPL
AddPage($orientation = '', $format = '')

See FPDF-Documentation ;-)

from FPDF_TPL
Link($x, $y, $w, $h, $link)

Preserve adding Links in Templates .

from FPDF_TPL
AddLink()

No description

from FPDF_TPL
SetLink($link, $y, $page = -1)

No description

from FPDF_TPL
_putformxobjects()

Private Method that writes the form xobjects

_putimages()

Overwritten to add _putformxobjects() after _putimages()

from FPDF_TPL
_putxobjectdict()

No description

from FPDF_TPL
_out($s)

Private Method

from FPDF_TPL
int
setSourceFile(string $filename)

Set a source-file

fpdi_pdf_parser
_getPdfParser(string $filename)

Returns a PDF parser object

string
getPDFVersion()

Get the current PDF version

string
setPDFVersion($version = '1.3')

Set the PDF version

int
importPage($pageno, $boxName = '/CropBox')

Import a page

getLastUsedPageBox()

No description

_putimportedobjects()

Private method, that rebuilds all needed objects of source files

_newobj($obj_id = false, $onlynewobj = false)

Rewritten to handle existing own defined objects

_straightOut($s)

Modified so not each call will add a newline to the output.

_enddoc()

rewritten to close opened parsers

_closeParsers()

close all files opened by parsers

Details

in FPDF at line 31
_putstream($s)

Parameters

$s

in FPDF at line 35
_getxobjectdict()

at line 395
pdf_write_value(array $value)

Writes a value Needed to rebuild the source document

Parameters

array $value

in FPDF at line 85
string _unescape(string $s)

Unescapes a PDF string

Parameters

string $s

Return Value

string

in FPDF at line 150
string hex2str(string $hex)

Hexadecimal to string

Parameters

string $hex

Return Value

string

in FPDF at line 160
string str2hex(string $str)

String to hexadecimal

Parameters

string $str

Return Value

string

in FPDF_TPL at line 76
int beginTemplate(int $x = null, int $y = null, int $w = null, int $h = null)

Start a Template

This method starts a template. You can give own coordinates to build an own sized Template. Pay attention, that the margins are adapted to the new templatesize. If you want to write outside the template, for example to build a clipped Template, you have to set the Margins and "Cursor"-Position manual after beginTemplate-Call.

If no parameter is given, the template uses the current page-size. The Method returns an ID of the current Template. This ID is used later for using this template. Warning: A created Template is used in PDF at all events. Still if you don't use it after creation!

Parameters

int $x The x-coordinate given in user-unit
int $y The y-coordinate given in user-unit
int $w The width given in user-unit
int $h The height given in user-unit

Return Value

int The ID of new created Template

in FPDF_TPL at line 134
mixed endTemplate()

End Template

This method ends a template and reset initiated variables on beginTemplate.

Return Value

mixed If a template is opened, the ID is returned. If not a false is returned.

at line 208
useTemplate(int $tplidx, int $_x = null, int $_y = null, int $_w, int $_h, $adjustPageSize = false)

Use a Template in current Page or other Template

You can use a template in a page or in another template. You can give the used template a new size like you use the Image()-method. All parameters are optional. The width or height is calculated automaticaly if one is given. If no parameter is given the origin size as defined in beginTemplate() is used. The calculated or used width and height are returned as an array.

Parameters

int $tplidx A valid template-Id
int $_x The x-position
int $_y The y-position
int $_w The new width of the template
int $_h The new height of the template
$adjustPageSize

in FPDF_TPL at line 238
array getTemplateSize(int $tplidx, int $_w, int $_h)

Get The calculated Size of a Template

If one size is given, this method calculates the other one.

Parameters

int $tplidx A valid template-Id
int $_w The width of the template
int $_h The height of the template

Return Value

array The height and width of the template

in FPDF_TPL at line 262
SetFont($family, $style = '', $size)

See FPDF/TCPDF-Documentation ;-)

Parameters

$family
$style
$size

in FPDF_TPL at line 288
Image($file, $x = null, $y = null, $w, $h, $type = '', $link = '')

See FPDF/TCPDF-Documentation ;-)

Parameters

$file
$x
$y
$w
$h
$type
$link

in FPDF_TPL at line 309
AddPage($orientation = '', $format = '')

See FPDF-Documentation ;-)

AddPage is not available when you're "in" a template.

Parameters

$orientation
$format

Preserve adding Links in Templates .

..won't work

Parameters

$x
$y
$w
$h
$link

Parameters

$link
$y
$page

at line 267
_putformxobjects()

Private Method that writes the form xobjects

in FPDF_TPL at line 424
_putimages()

Overwritten to add _putformxobjects() after _putimages()

in FPDF_TPL at line 429
_putxobjectdict()

in FPDF_TPL at line 442
_out($s)

Private Method

Parameters

$s

at line 86
int setSourceFile(string $filename)

Set a source-file

Parameters

string $filename a valid filename

Return Value

int number of available pages

at line 102
fpdi_pdf_parser _getPdfParser(string $filename)

Returns a PDF parser object

Parameters

string $filename

Return Value

fpdi_pdf_parser

at line 111
string getPDFVersion()

Get the current PDF version

Return Value

string

at line 120
string setPDFVersion($version = '1.3')

Set the PDF version

Parameters

$version

Return Value

string

at line 130
int importPage($pageno, $boxName = '/CropBox')

Import a page

Parameters

$pageno
$boxName

Return Value

int Index of imported page - to use with fpdf_tpl::useTemplate()

at line 204
getLastUsedPageBox()

at line 237
_putimportedobjects()

Private method, that rebuilds all needed objects of source files

at line 374
_newobj($obj_id = false, $onlynewobj = false)

Rewritten to handle existing own defined objects

Parameters

$obj_id
$onlynewobj

at line 497
_straightOut($s)

Modified so not each call will add a newline to the output.

Parameters

$s

at line 523
_enddoc()

rewritten to close opened parsers

at line 531
_closeParsers()

close all files opened by parsers