class ExportRelationSchema (View source)

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

Properties

protected bool $showColor
protected bool $tableDimension
protected bool $sameWide
protected bool $showKeys
protected string $orientation
protected string $paper
protected int $pageNumber
protected bool $offline

Methods

__construct(Relation $relation, DatabaseName $db)

No description

void
setPageNumber(int $value)

Set Page Number

int
getPageNumber()

Returns the schema page number

void
setShowColor(bool $value)

Sets showColor

bool
isShowColor()

Returns whether to show colors

void
setTableDimension(bool $value)

Set Table Dimension

bool
isTableDimension()

Returns whether to show table dimensions

void
setAllTablesSameWidth(bool $value)

Set same width of All Tables

bool
isAllTableSameWidth()

Returns whether to use same width for all tables or not

void
setShowKeys(bool $value)

Set Show only keys

bool
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(bool $value)

Set whether the document is generated from client side DB

array
getTablesFromRequest()

Get the table names from the request

string
getFileName(string $extension)

No description

static never
dieSchema(int $pageNumber, string $type = '', string $errorMessage = '')

Displays an error message

Details

__construct(Relation $relation, DatabaseName $db)

No description

Parameters

Relation $relation
DatabaseName $db

void setPageNumber(int $value)

Set Page Number

Parameters

int $value

Page Number of the document to be created

Return Value

void

int getPageNumber()

Returns the schema page number

Return Value

int

schema page number

void setShowColor(bool $value)

Sets showColor

Parameters

bool $value

whether to show colors

Return Value

void

bool isShowColor()

Returns whether to show colors

Return Value

bool

void setTableDimension(bool $value)

Set Table Dimension

Parameters

bool $value

show table co-ordinates or not

Return Value

void

bool isTableDimension()

Returns whether to show table dimensions

Return Value

bool

void setAllTablesSameWidth(bool $value)

Set same width of All Tables

Parameters

bool $value

set same width of all tables or not

Return Value

void

bool isAllTableSameWidth()

Returns whether to use same width for all tables or not

Return Value

bool

void setShowKeys(bool $value)

Set Show only keys

Parameters

bool $value

show only keys or not

Return Value

void

bool isShowKeys()

Returns whether to show keys

Return Value

bool

void setOrientation(string $value)

Set Orientation

Parameters

string $value

Orientation will be portrait or landscape

Return Value

void

string getOrientation()

Returns orientation

Return Value

string orientation

void setPaper(string $value)

Set type of paper

Parameters

string $value

paper type can be A4 etc

Return Value

void

string getPaper()

Returns the paper size

Return Value

string

paper size

void setOffline(bool $value)

Set whether the document is generated from client side DB

Parameters

bool $value

offline or not

Return Value

void

protected array getTablesFromRequest()

Get the table names from the request

Return Value

array

an array of table names

protected string getFileName(string $extension)

No description

Parameters

string $extension

Return Value

string

static never dieSchema(int $pageNumber, string $type = '', string $errorMessage = '')

Displays an error message

Parameters

int $pageNumber

ID of the chosen page

string $type

Schema Type

string $errorMessage

The error message

Return Value

never