PdfRelationSchema
class PdfRelationSchema extends ExportRelationSchema (View source)
Pdf Relation Schema Class
Purpose of this class is to generate the PDF Document. PDF is widely used format for documenting text,fonts,images and 3d vector graphics.
This class inherits ExportRelationSchema class has common functionality added to this class
Properties
| protected bool | $showColor | from ExportRelationSchema | |
| protected bool | $tableDimension | from ExportRelationSchema | |
| protected bool | $sameWide | from ExportRelationSchema | |
| protected bool | $showKeys | from ExportRelationSchema | |
| protected string | $orientation | from ExportRelationSchema | |
| protected string | $paper | from ExportRelationSchema | |
| protected int | $pageNumber | from ExportRelationSchema | |
| protected bool | $offline | from ExportRelationSchema | |
| protected RelationStatsPdf[] | $relations |
Methods
Returns whether to use same width for all tables or not
Set whether the document is generated from client side DB
Displays an error message
Set Show Grid
Returns whether to show grid
Set Data Dictionary
Return whether to show selected database data dictionary or not
Sets the order of the table in data dictionary
Returns the order of the table in data dictionary
No description
Generates data dictionary pages.
Details
__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
bool
isOffline()
Returns whether the client side database is used
protected array
getTablesFromRequest()
Get the table names from the request
protected string
getFileName(string $extension)
No description
static never
dieSchema(int $pageNumber, string $type = '', string $errorMessage = '')
Displays an error message
void
setShowGrid(bool $value)
Set Show Grid
bool
isShowGrid()
Returns whether to show grid
void
setWithDataDictionary(bool $value)
Set Data Dictionary
bool
isWithDataDictionary()
Return whether to show selected database data dictionary or not
void
setTableOrder(string $value)
Sets the order of the table in data dictionary
string
getTableOrder()
Returns the order of the table in data dictionary
array
getExportInfo()
No description
void
dataDictionaryDoc(array $alltables)
Generates data dictionary pages.