class Pdf extends Pdf

Extends the "TCPDF" class and helps in developing the structure of PDF Schema Export

Constants

PMA_PDF_FONT

PDF font to use.

Properties

$footerset from Pdf
$Alias from Pdf
$_xMin Defines properties
$_yMin
$leftMargin
$topMargin
$scale
$PMA_links
$Outlines
$def_outlines
$widths
$cMargin

Methods

__construct(string $orientation, string $unit, string $paper, int $pageNumber, boolean $withDoc, string $db)

Constructs PDF for schema export.

Footer()

No description

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
Error($error_message = '')

No description

from Pdf
void
download(string $filename)

Sends file as a download to user.

from Pdf
void
setCMargin(float $c_margin)

Sets the value for margins

void
setScale(float|int $scale = 1, float|int $xMin = 0, float|int $yMin = 0, float|int $leftMargin = -1, float|int $topMargin = -1)

Sets the scaling factor, defines minimum coordinates and margins

void
cellScale(float|int $w, float|int $h = 0, string $txt = '', mixed $border = 0, integer $ln = 0, string $align = '', integer $fill = 0, string $link = '')

Outputs a scaled cell

void
lineScale(float $x1, float $y1, float $x2, float $y2)

Draws a scaled line

void
setXyScale(float $x, float $y)

Sets x and y scaled positions

void
setXScale(float $x)

Sets the X scaled positions

void
setFontSizeScale(float $size)

Sets the scaled font size

void
setLineWidthScale(float $width)

Sets the scaled line width

Header()

No description

void
setWidths(array $w)

Sets widths

void
row(array $data, array $links)

Generates table row.

int
numLines(int $w, string $txt)

Compute number of lines used by a multicell of width w

void
setOffline(string $value)

Set whether the document is generated from client side DB

Details

at line 76
__construct(string $orientation, string $unit, string $paper, int $pageNumber, boolean $withDoc, string $db)

Constructs PDF for schema export.

Parameters

string $orientation page orientation
string $unit unit
string $paper the format used for pages
int $pageNumber schema page number that is being exported
boolean $withDoc with document dictionary
string $db the database name

in Pdf at line 111
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

in Pdf at line 132
void _putpages()

Improved with alias expanding.

Return Value

void

in Pdf at line 151
Error($error_message = '')

Parameters

$error_message

in Pdf at line 166
void download(string $filename)

Sends file as a download to user.

Parameters

string $filename file name

Return Value

void

at line 98
void setCMargin(float $c_margin)

Sets the value for margins

Parameters

float $c_margin margin

Return Value

void

at line 114
void setScale(float|int $scale = 1, float|int $xMin = 0, float|int $yMin = 0, float|int $leftMargin = -1, float|int $topMargin = -1)

Sets the scaling factor, defines minimum coordinates and margins

Parameters

float|int $scale The scaling factor
float|int $xMin The minimum X coordinate
float|int $yMin The minimum Y coordinate
float|int $leftMargin The left margin
float|int $topMargin The top margin

Return Value

void

at line 148
void cellScale(float|int $w, float|int $h = 0, string $txt = '', mixed $border = 0, integer $ln = 0, string $align = '', integer $fill = 0, string $link = '')

Outputs a scaled cell

Parameters

float|int $w The cell width
float|int $h The cell height
string $txt The text to output
mixed $border Whether to add borders or not
integer $ln Where to put the cursor once the output is done
string $align Align mode
integer $fill Whether to fill the cell with a color or not
string $link Link

Return Value

void

See also

at line 175
void lineScale(float $x1, float $y1, float $x2, float $y2)

Draws a scaled line

Parameters

float $x1 The horizontal position of the starting point
float $y1 The vertical position of the starting point
float $x2 The horizontal position of the ending point
float $y2 The vertical position of the ending point

Return Value

void

See also

at line 194
void setXyScale(float $x, float $y)

Sets x and y scaled positions

Parameters

float $x The x position
float $y The y position

Return Value

void

See also

at line 210
void setXScale(float $x)

Sets the X scaled positions

Parameters

float $x The x position

Return Value

void

See also

at line 225
void setFontSizeScale(float $size)

Sets the scaled font size

Parameters

float $size The font size (in points)

Return Value

void

See also

at line 241
void setLineWidthScale(float $width)

Sets the scaled line width

Parameters

float $width The line width

Return Value

void

See also

at line 255
Header()

at line 303
void setWidths(array $w)

Sets widths

Parameters

array $w array of widths

Return Value

void

at line 317
void row(array $data, array $links)

Generates table row.

Parameters

array $data Data for table
array $links Links for table cells

Return Value

void

at line 358
int numLines(int $w, string $txt)

Compute number of lines used by a multicell of width w

Parameters

int $w width
string $txt text

Return Value

int

at line 417
void setOffline(string $value)

Set whether the document is generated from client side DB

Parameters

string $value whether offline

Return Value

void