class Pdf extends Pdf (View source)

Adapted from a LGPL script by Philip Clarke

Constants

PMA_PDF_FONT

PDF font to use.

Properties

array $footerset from  Pdf
array $alias from  Pdf
array $tablewidths
array $headerset

Methods

__construct(string $orientation = 'P', string $unit = 'mm', string $format = 'A4', bool $unicode = true, string $encoding = 'UTF-8', bool $diskcache = false, false|int $pdfa = false)

Constructs PDF and configures standard parameters.

void
Footer()

This function must be named "Footer" to work with the TCPDF library

from  Pdf
void
setAlias(string $name, string $value)

Function to set alias which will be expanded on page rendering.

from  Pdf
void
_putpages()

Improved with alias expanding.

from  Pdf
void
Error(string $error_message = '')

Displays an error message

from  Pdf
void
download(string $filename)

Sends file as a download to user.

from  Pdf
bool
checkPageBreak(float|int $h = 0, mixed $y = '', bool $addpage = true)

Add page if needed.

void
Header()

This method is used to render the page header.

void
morepagestable(int $lineheight = 8)

Generate table

void
setTopMargin(float $topMargin)

Defines the top margin.

void
getTriggers(string $db, string $table)

Prints triggers

void
getTableDef(string $db, string $table, bool $do_relation, bool $do_comments, bool $do_mime, bool $view = false, array $aliases = [])

Print $table's CREATE definition

void
mysqlReport(string $query)

MySQL report

void
setTitleFontSize(int $titleFontSize)

No description

void
setTitleText(string $titleText)

No description

void
setCurrentDb(string|null $currentDb)

No description

void
setCurrentTable(string|null $currentTable)

No description

void
setDbAlias(string|null $dbAlias)

No description

void
setTableAlias(string|null $tableAlias)

No description

void
setAliases(array $aliases)

No description

void
setPurpose(string $purpose)

No description

Details

__construct(string $orientation = 'P', string $unit = 'mm', string $format = 'A4', bool $unicode = true, string $encoding = 'UTF-8', bool $diskcache = false, false|int $pdfa = false)

Constructs PDF and configures standard parameters.

Parameters

string $orientation

page orientation

string $unit unit
string $format

the format used for pages

bool $unicode

true means that the input text is unicode

string $encoding

charset encoding; default is UTF-8.

bool $diskcache

DEPRECATED TCPDF FEATURE

false|int $pdfa

If not false, set the document to PDF/A mode and the good version (1 or 3)

This function must be named "Footer" to work with the TCPDF library

Return Value

void

void setAlias(string $name, string $value)

Function to set alias which will be expanded on page rendering.

Parameters

string $name

name of the alias

string $value

value of the alias

Return Value

void

void _putpages()

Improved with alias expanding.

Return Value

void

void Error(string $error_message = '')

Displays an error message

Parameters

string $error_message

the error message

Return Value

void

void download(string $filename)

Sends file as a download to user.

Parameters

string $filename

file name

Return Value

void

bool checkPageBreak(float|int $h = 0, mixed $y = '', bool $addpage = true)

Add page if needed.

Parameters

float|int $h

cell height. Default value: 0

mixed $y

starting y position, leave empty for current position

bool $addpage

if true add a page, otherwise only return the true/false state

Return Value

bool

void Header()

This method is used to render the page header.

Return Value

void

void morepagestable(int $lineheight = 8)

Generate table

Parameters

int $lineheight

Height of line

Return Value

void

void setTopMargin(float $topMargin)

Defines the top margin.

The method can be called before creating the first page.

Parameters

float $topMargin

the margin

Return Value

void

void getTriggers(string $db, string $table)

Prints triggers

Parameters

string $db

database name

string $table

table name

Return Value

void

void getTableDef(string $db, string $table, bool $do_relation, bool $do_comments, bool $do_mime, bool $view = false, array $aliases = [])

Print $table's CREATE definition

Parameters

string $db

the database name

string $table

the table name

bool $do_relation

whether to include relation comments

bool $do_comments

whether to include the pmadb-style column comments as comments in the structure; this is deprecated but the parameter is left here because /export calls PMA_exportStructure() also for other export types which use this parameter

bool $do_mime

whether to include mime comments

bool $view

whether we're handling a view

array $aliases

aliases of db/table/columns

Return Value

void

void mysqlReport(string $query)

MySQL report

Parameters

string $query

Query to execute

Return Value

void

void setTitleFontSize(int $titleFontSize)

No description

Parameters

int $titleFontSize

Return Value

void

void setTitleText(string $titleText)

No description

Parameters

string $titleText

Return Value

void

void setCurrentDb(string|null $currentDb)

No description

Parameters

string|null $currentDb

Return Value

void

void setCurrentTable(string|null $currentTable)

No description

Parameters

string|null $currentTable

Return Value

void

void setDbAlias(string|null $dbAlias)

No description

Parameters

string|null $dbAlias

Return Value

void

void setTableAlias(string|null $tableAlias)

No description

Parameters

string|null $tableAlias

Return Value

void

void setAliases(array $aliases)

No description

Parameters

array $aliases

Return Value

void

void setPurpose(string $purpose)

No description

Parameters

string $purpose

Return Value

void