PHP Class PMA\libraries\plugins\schema\pdf\Pdf

See also: TCPDF
Inheritance: extends PMA\libraries\PDF
Show file Open project: phpmyadmin/phpmyadmin

Public Properties

Property Type Description
$Outlines
$PMA_links
$_xMin Defines properties
$_yMin
$def_outlines
$leftMargin
$scale
$topMargin
$widths

Public Methods

Method Description
Footer ( ) : void This function must be named "Footer" to work with the TCPDF library
Header ( ) : void This method is used to render the page header.
NbLines ( integer $w, string $txt ) : integer Compute number of lines used by a multicell of width w
Row ( array $data, array $links ) : void Generates table row.
SetWidths ( array $w ) : void Sets widths
__construct ( string $orientation, string $unit, string $paper, integer $pageNumber, boolean $withDoc, string $db ) Constructs PDF for schema export.
cellScale ( float | integer $w, float | integer $h, string $txt = '', mixed $border, integer $ln, string $align = '', integer $fill, string $link = '' ) : void Outputs a scaled cell
lineScale ( float $x1, float $y1, float $x2, float $y2 ) : void Draws a scaled line
setCMargin ( float $c_margin ) : void Sets the value for margins
setFontSizeScale ( float $size ) : void Sets the scaled font size
setLineWidthScale ( float $width ) : void Sets the scaled line width
setOffline ( string $value ) : void Set whether the document is generated from client side DB
setScale ( float | integer $scale = 1, float | integer $xMin, float | integer $yMin, float | integer $leftMargin, float | integer $topMargin ) : void Sets the scaling factor, defines minimum coordinates and margins
setXScale ( float $x ) : void Sets the X scaled positions
setXyScale ( float $x, float $y ) : void Sets x and y scaled positions

Method Details

Header() public method

This method is used to render the page header.
See also: TCPDF::Header()
public Header ( ) : void
return void

NbLines() public method

Compute number of lines used by a multicell of width w
public NbLines ( integer $w, string $txt ) : integer
$w integer width
$txt string text
return integer

Row() public method

Generates table row.
public Row ( array $data, array $links ) : void
$data array Data for table
$links array Links for table cells
return void

SetWidths() public method

Sets widths
public SetWidths ( array $w ) : void
$w array array of widths
return void

__construct() public method

Constructs PDF for schema export.
public __construct ( string $orientation, string $unit, string $paper, integer $pageNumber, boolean $withDoc, string $db )
$orientation string page orientation
$unit string unit
$paper string the format used for pages
$pageNumber integer schema page number that is being exported
$withDoc boolean with document dictionary
$db string the database name

cellScale() public method

Outputs a scaled cell
See also: TCPDF::Cell()
public cellScale ( float | integer $w, float | integer $h, string $txt = '', mixed $border, integer $ln, string $align = '', integer $fill, string $link = '' ) : void
$w float | integer The cell width
$h float | integer The cell height
$txt string The text to output
$border mixed Whether to add borders or not
$ln integer Where to put the cursor once the output is done
$align string Align mode
$fill integer Whether to fill the cell with a color or not
$link string Link
return void

lineScale() public method

Draws a scaled line
See also: TCPDF::Line()
public lineScale ( float $x1, float $y1, float $x2, float $y2 ) : void
$x1 float The horizontal position of the starting point
$y1 float The vertical position of the starting point
$x2 float The horizontal position of the ending point
$y2 float The vertical position of the ending point
return void

setCMargin() public method

Sets the value for margins
public setCMargin ( float $c_margin ) : void
$c_margin float margin
return void

setFontSizeScale() public method

Sets the scaled font size
See also: TCPDF::SetFontSize()
public setFontSizeScale ( float $size ) : void
$size float The font size (in points)
return void

setLineWidthScale() public method

Sets the scaled line width
See also: TCPDF::SetLineWidth()
public setLineWidthScale ( float $width ) : void
$width float The line width
return void

setOffline() public method

Set whether the document is generated from client side DB
public setOffline ( string $value ) : void
$value string whether offline
return void

setScale() public method

Sets the scaling factor, defines minimum coordinates and margins
public setScale ( float | integer $scale = 1, float | integer $xMin, float | integer $yMin, float | integer $leftMargin, float | integer $topMargin ) : void
$scale float | integer The scaling factor
$xMin float | integer The minimum X coordinate
$yMin float | integer The minimum Y coordinate
$leftMargin float | integer The left margin
$topMargin float | integer The top margin
return void

setXScale() public method

Sets the X scaled positions
See also: TCPDF::SetX()
public setXScale ( float $x ) : void
$x float The x position
return void

setXyScale() public method

Sets x and y scaled positions
See also: TCPDF::SetXY()
public setXyScale ( float $x, float $y ) : void
$x float The x position
$y float The y position
return void

Property Details

$Outlines public property

public $Outlines

$_xMin public property

Defines properties
public $_xMin

$_yMin public property

public $_yMin

$def_outlines public property

public $def_outlines

$leftMargin public property

public $leftMargin

$scale public property

public $scale

$topMargin public property

public $topMargin

$widths public property

public $widths