PHP Class PMA\libraries\plugins\schema\ExportRelationSchema

Mostrar archivo Open project: phpmyadmin/phpmyadmin Class Usage Examples

Protected Properties

Property Type Description
$db
$diagram
$offline
$orientation
$pageNumber
$paper
$sameWide
$showColor
$showKeys
$tableDimension

Public Methods

Method Description
__construct ( string $db, object $diagram ) Constructor.
dieSchema ( integer $pageNumber, string $type = '', string $error_message = '' ) : void Displays an error message
getOrientation ( ) : string Returns orientation
getPageNumber ( ) : integer Returns the schema page number
getPaper ( ) : string Returns the paper size
isAllTableSameWidth ( ) : boolean Returns whether to use same width for all tables or not
isOffline ( ) : boolean Returns whether the client side database is used
isShowColor ( ) : boolean Returns whether to show colors
isShowKeys ( ) : boolean Returns whether to show keys
isTableDimension ( ) : boolean Returns whether to show table dimensions
setAllTablesSameWidth ( boolean $value ) : void Set same width of All Tables
setOffline ( boolean $value ) : void Set whether the document is generated from client side DB
setOrientation ( string $value ) : void Set Orientation
setPageNumber ( integer $value ) : void Set Page Number
setPaper ( string $value ) : void Set type of paper
setShowColor ( boolean $value ) : void Sets showColor
setShowKeys ( boolean $value ) : void Set Show only keys
setTableDimension ( boolean $value ) : void Set Table Dimension

Protected Methods

Method Description
getFileName ( String $extension ) : string Returns the file name
getTablesFromRequest ( ) : array Get the table names from the request

Method Details

__construct() public method

Constructor.
public __construct ( string $db, object $diagram )
$db string database name
$diagram object schema diagram

dieSchema() public static method

Displays an error message
public static dieSchema ( integer $pageNumber, string $type = '', string $error_message = '' ) : void
$pageNumber integer ID of the chosen page
$type string Schema Type
$error_message string The error message
return void

getFileName() protected method

Returns the file name
protected getFileName ( String $extension ) : string
$extension String file extension
return string file name

getOrientation() public method

Returns orientation
public getOrientation ( ) : string
return string orientation

getPageNumber() public method

Returns the schema page number
public getPageNumber ( ) : integer
return integer schema page number

getPaper() public method

Returns the paper size
public getPaper ( ) : string
return string paper size

getTablesFromRequest() protected method

Get the table names from the request
protected getTablesFromRequest ( ) : array
return array an array of table names

isAllTableSameWidth() public method

Returns whether to use same width for all tables or not
public isAllTableSameWidth ( ) : boolean
return boolean whether to use same width for all tables or not

isOffline() public method

Returns whether the client side database is used
public isOffline ( ) : boolean
return boolean

isShowColor() public method

Returns whether to show colors
public isShowColor ( ) : boolean
return boolean whether to show colors

isShowKeys() public method

Returns whether to show keys
public isShowKeys ( ) : boolean
return boolean whether to show keys

isTableDimension() public method

Returns whether to show table dimensions
public isTableDimension ( ) : boolean
return boolean whether to show table dimensions

setAllTablesSameWidth() public method

Set same width of All Tables
public setAllTablesSameWidth ( boolean $value ) : void
$value boolean set same width of all tables or not
return void

setOffline() public method

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

setOrientation() public method

Set Orientation
public setOrientation ( string $value ) : void
$value string Orientation will be portrait or landscape
return void

setPageNumber() public method

Set Page Number
public setPageNumber ( integer $value ) : void
$value integer Page Number of the document to be created
return void

setPaper() public method

Set type of paper
public setPaper ( string $value ) : void
$value string paper type can be A4 etc
return void

setShowColor() public method

Sets showColor
public setShowColor ( boolean $value ) : void
$value boolean whether to show colors
return void

setShowKeys() public method

Set Show only keys
public setShowKeys ( boolean $value ) : void
$value boolean show only keys or not
return void

setTableDimension() public method

Set Table Dimension
public setTableDimension ( boolean $value ) : void
$value boolean show table co-ordinates or not
return void

Property Details

$db protected_oe property

protected $db

$diagram protected_oe property

protected $diagram

$offline protected_oe property

protected $offline

$orientation protected_oe property

protected $orientation

$pageNumber protected_oe property

protected $pageNumber

$paper protected_oe property

protected $paper

$sameWide protected_oe property

protected $sameWide

$showColor protected_oe property

protected $showColor

$showKeys protected_oe property

protected $showKeys

$tableDimension protected_oe property

protected $tableDimension