Documentation

TableGenerator extends BackendTable
in package

Creates a table view

Tags
copyright

CLOUDREXX CMS - CLOUDREXX AG

author

CLOUDREXX Development Team info@cloudrexx.com

subpackage

core_html

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
Overwrites the constructor to convert the $attr array into a dataset to flip it and show the attributes besides the values.
_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

$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

Methods

__construct()

Overwrites the constructor to convert the $attr array into a dataset to flip it and show the attributes besides the values.

public __construct([mixed $attrs = array() ][, mixed $options = array() ][, bool $readOnly = false ]) : mixed
Parameters
$attrs : mixed = array()

array attributes and values

$options : mixed = array()

array options for view generator

$readOnly : bool = false

if view is only readable

_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
access

private

Return values
string

setCellContents()

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
type

toHtml()

Returns the table structure as HTML Override in order to use Sigma for parsing

public toHtml() : string
Tags
access

public

global

array $_ARRAYLANG array containing the language variables

Return values
string

encodeCellContent()

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 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results