BackendTable
extends HTML_Table
in package
BackendTable
Tags
Table of Contents
Properties
- $editable : bool
- $hasMasterTableHeader : mixed
- Whether or not the table has a master table header.
- $multiActions : array<string|int, mixed>
- Will be set to the value of `$options['multiaction']` by the constructor.
- $templateFile : string
- $viewGenerator : ViewGenerator
Methods
- __construct() : mixed
- BackendTable constructor.
- _getAttrString() : string
- Returns an HTML formatted attribute string Use Sigma for parsing
- setCellContents() : type
- Override from parent. Added contrexx_raw2xhtml support
- toHtml() : string
- Returns the table structure as HTML Override in order to use Sigma for parsing
- encodeCellContent() : mixed
- Encode the cell content
- getFunctionsCode() : mixed
- getOverallFunctionsCode() : string
- Returns HTML code for functions regarding all entries
- hasRowFunctions() : mixed
- parseStorage() : mixed
- This is a soft override of Storage's toHtml() in order to use Sigma for parsing
Properties
$editable
protected
bool
$editable
= \false
if table is editable
$hasMasterTableHeader
Whether or not the table has a master table header.
protected
mixed
$hasMasterTableHeader
= \false
A master table header is used as a title and is being parsed as TH tags. If no master table header is set, then the column labels will be used as the master table header and are being parsed as TH tags. Otherwise, if a master table header is set, the column labels are being parsed as regular TD tags, but with row class row3.
$multiActions
Will be set to the value of `$options['multiaction']` by the constructor.
protected
array<string|int, mixed>
$multiActions
= []
$templateFile
protected
string
$templateFile
= ''
Fully qualified template file name
$viewGenerator
protected
ViewGenerator
$viewGenerator
instance of ViewGenerator so we can load more than one view
Methods
__construct()
BackendTable constructor.
public
__construct([array<string|int, mixed> $attrs = array() ][, array<string|int, mixed> $options = array() ][, string $entityClass = '' ][, ViewGenerator $viewGenerator = null ][, bool $readOnly = false ]) : mixed
Parameters
- $attrs : array<string|int, mixed> = array()
-
attributes of view generator
- $options : array<string|int, mixed> = array()
-
options of view generator
- $entityClass : string = ''
-
class name of entity
- $viewGenerator : ViewGenerator = null
-
instance of ViewGenerator
- $readOnly : bool = false
-
if view is only readable
Tags
_getAttrString()
Returns an HTML formatted attribute string Use Sigma for parsing
public
_getAttrString(array<string|int, mixed> $attributes) : string
Parameters
- $attributes : array<string|int, mixed>
Tags
Return values
stringsetCellContents()
Override from parent. Added contrexx_raw2xhtml support
public
setCellContents(type $row, type $col, type $contents[, type $type = 'TD' ][, type $body = 0 ][, type $encode = false ]) : type
Parameters
- $row : type
- $col : type
- $contents : type
- $type : type = 'TD'
- $body : type = 0
- $encode : type = false
Return values
typetoHtml()
Returns the table structure as HTML Override in order to use Sigma for parsing
public
toHtml() : string
Tags
Return values
stringencodeCellContent()
Encode the cell content
protected
encodeCellContent(mixed $contents) : mixed
Parameters
- $contents : mixed
-
mixed content for the cell
Return values
mixed —encoded cell content
getFunctionsCode()
protected
getFunctionsCode(mixed $rowname, mixed $rowData, mixed $functions[, mixed $virtual = false ]) : mixed
Parameters
- $rowname : mixed
- $rowData : mixed
- $functions : mixed
- $virtual : mixed = false
getOverallFunctionsCode()
Returns HTML code for functions regarding all entries
protected
getOverallFunctionsCode(array<string|int, mixed> $functions, object $renderObject) : string
Parameters
- $functions : array<string|int, mixed>
-
Function config
- $renderObject : object
-
Currently rendered object
Return values
string —HTML
hasRowFunctions()
protected
hasRowFunctions(mixed $functions[, mixed $virtual = false ]) : mixed
Parameters
- $functions : mixed
- $virtual : mixed = false
parseStorage()
This is a soft override of Storage's toHtml() in order to use Sigma for parsing
protected
parseStorage(mixed $template, mixed $storage) : mixed
Parameters
- $template : mixed
- $storage : mixed