class ExportRelationSchema

This class is inherited by all schema classes It contains those methods which are common in them it works like factory pattern

Properties

protected $db
protected $diagram
protected $showColor
protected $tableDimension
protected $sameWide
protected $showKeys
protected $orientation
protected $paper
protected $pageNumber
protected $offline
protected Relation $relation

Methods

__construct(string $db, Pdf|Svg|Eps|Dia|Pdf|null $diagram)

Constructor.

void
setPageNumber(integer $value)

Set Page Number

integer
getPageNumber()

Returns the schema page number

void
setShowColor(boolean $value)

Sets showColor

boolean
isShowColor()

Returns whether to show colors

void
setTableDimension(boolean $value)

Set Table Dimension

boolean
isTableDimension()

Returns whether to show table dimensions

void
setAllTablesSameWidth(boolean $value)

Set same width of All Tables

boolean
isAllTableSameWidth()

Returns whether to use same width for all tables or not

void
setShowKeys(boolean $value)

Set Show only keys

boolean
isShowKeys()

Returns whether to show keys

void
setOrientation(string $value)

Set Orientation

string
getOrientation()

Returns orientation

void
setPaper(string $value)

Set type of paper

string
getPaper()

Returns the paper size

void
setOffline(boolean $value)

Set whether the document is generated from client side DB

boolean
isOffline()

Returns whether the client side database is used

array
getTablesFromRequest()

Get the table names from the request

string
getFileName(String $extension)

Returns the file name

static void
dieSchema(integer $pageNumber, string $type = '', string $error_message = '')

Displays an error message

Details

at line 48
__construct(string $db, Pdf|Svg|Eps|Dia|Pdf|null $diagram)

Constructor.

Parameters

string $db database name
Pdf|Svg|Eps|Dia|Pdf|null $diagram schema diagram

at line 64
void setPageNumber(integer $value)

Set Page Number

Parameters

integer $value Page Number of the document to be created

Return Value

void

at line 74
integer getPageNumber()

Returns the schema page number

Return Value

integer schema page number

at line 86
void setShowColor(boolean $value)

Sets showColor

Parameters

boolean $value whether to show colors

Return Value

void

at line 96
boolean isShowColor()

Returns whether to show colors

Return Value

boolean whether to show colors

at line 108
void setTableDimension(boolean $value)

Set Table Dimension

Parameters

boolean $value show table co-ordinates or not

Return Value

void

at line 118
boolean isTableDimension()

Returns whether to show table dimensions

Return Value

boolean whether to show table dimensions

at line 130
void setAllTablesSameWidth(boolean $value)

Set same width of All Tables

Parameters

boolean $value set same width of all tables or not

Return Value

void

at line 140
boolean isAllTableSameWidth()

Returns whether to use same width for all tables or not

Return Value

boolean whether to use same width for all tables or not

at line 154
void setShowKeys(boolean $value)

Set Show only keys

Parameters

boolean $value show only keys or not

Return Value

void

at line 164
boolean isShowKeys()

Returns whether to show keys

Return Value

boolean whether to show keys

at line 178
void setOrientation(string $value)

Set Orientation

Parameters

string $value Orientation will be portrait or landscape

Return Value

void

at line 188
string getOrientation()

Returns orientation

Return Value

string orientation

at line 202
void setPaper(string $value)

Set type of paper

Parameters

string $value paper type can be A4 etc

Return Value

void

at line 212
string getPaper()

Returns the paper size

Return Value

string paper size

at line 226
void setOffline(boolean $value)

Set whether the document is generated from client side DB

Parameters

boolean $value offline or not

Return Value

void

at line 238
boolean isOffline()

Returns whether the client side database is used

Return Value

boolean

at line 248
protected array getTablesFromRequest()

Get the table names from the request

Return Value

array an array of table names

at line 266
protected string getFileName(String $extension)

Returns the file name

Parameters

String $extension file extension

Return Value

string file name

at line 294
static void dieSchema(integer $pageNumber, string $type = '', string $error_message = '')

Displays an error message

Parameters

integer $pageNumber ID of the chosen page
string $type Schema Type
string $error_message The error message

Return Value

void