htmlTable
extends htmlElement
in package
Structures elements using a table.
Table of Contents
- ALIGN_BOTTOM = 3
- align to bottom
- ALIGN_CENTER = 4
- align to center
- ALIGN_LEFT = 1
- align to left
- ALIGN_RIGHT = 2
- align to right
- ALIGN_TOP = 0
- align to top
- FOOTER = "</table>\n"
- table footer
- NEWLINE = "</tr><tr>\n"
- new line
- $alignment : mixed
- alignment when inside a table
- $colspan : mixed
- colspan if inside a table
- $rowspan : mixed
- rowspan if inside a table
- $cssClasses : mixed
- CSS classes
- $tableCellCssClasses : mixed
- table cell CSS classes
- $accessibilityLabel : string|null
- accessibility label
- $dataAttributes : mixed
- data attributes
- $elements : mixed
- list of subelements
- $id : mixed
- HTML ID
- $rowOpen : mixed
- specifies if currently a row is open
- $width : mixed
- table width
- __construct() : mixed
- Constructor
- addDataAttribute() : mixed
- Adds a data attribute.
- addElement() : mixed
- Adds an element to the table. The element may be a htmlElement object or a simple String.
- addNewLine() : mixed
- Adds another line to the table.
- addSpace() : mixed
- Adds an htmlSpacer with the given width.
- addVerticalSpace() : mixed
- Adds an htmlSpacer with the given height and ends the row.
- generateHTML() : array<string|int, mixed>
- Prints the HTML code for this element.
- getAccessibilityMarkup() : string
- Returns the markup for the accessibility data.
- getAlignmentString() : string
- Returns the HTML attributes for the alignment.
- getColspanString() : string
- Returns the HTML attribute for the colspan.
- getCSSClasses() : array<string|int, mixed>
- Returns the CSS classes of this element.
- getRowspanString() : string
- Returns the HTML attribute for the rowspan.
- getTableCellCSSClasses() : array<string|int, mixed>
- Returns the CSS classes of the surrounding table cell for this element.
- mergeTableElements() : mixed
- Merges the content of another htmlTable object into this table.
- setAccessibilityLabel() : void
- Sets the accessibility label.
- setCSSClasses() : mixed
- Adds CSS classes to this element.
- setTableCellCSSClasses() : mixed
- Adds CSS classes to the surrounding table cell for this element.
- getDataAttributesAsString() : string
- Returns the data attributes as rendered string.
Constants
ALIGN_BOTTOM
align to bottom
public
mixed
ALIGN_BOTTOM
= 3
ALIGN_CENTER
align to center
public
mixed
ALIGN_CENTER
= 4
ALIGN_LEFT
align to left
public
mixed
ALIGN_LEFT
= 1
ALIGN_RIGHT
align to right
public
mixed
ALIGN_RIGHT
= 2
ALIGN_TOP
align to top
public
mixed
ALIGN_TOP
= 0
FOOTER
table footer
public
mixed
FOOTER
= "</table>\n"
NEWLINE
new line
public
mixed
NEWLINE
= "</tr><tr>\n"
Properties
$alignment
alignment when inside a table
public
mixed
$alignment
$colspan
colspan if inside a table
public
mixed
$colspan
$rowspan
rowspan if inside a table
public
mixed
$rowspan
$cssClasses
CSS classes
protected
mixed
$cssClasses
= []
$tableCellCssClasses
table cell CSS classes
protected
mixed
$tableCellCssClasses
= []
$accessibilityLabel
accessibility label
private
string|null
$accessibilityLabel
= \null
$dataAttributes
data attributes
private
mixed
$dataAttributes
= []
$elements
list of subelements
private
mixed
$elements
= []
$id
HTML ID
private
mixed
$id
$rowOpen
specifies if currently a row is open
private
mixed
$rowOpen
= \false
$width
table width
private
mixed
$width
Methods
__construct()
Constructor
public
__construct([string $width = null ][, mixed $id = null ]) : mixed
Parameters
- $width : string = null
-
table width (e.g. 100%)
- $id : mixed = null
Tags
Return values
mixed —addDataAttribute()
Adds a data attribute.
public
addDataAttribute(string $key, string $value) : mixed
Parameters
- $key : string
-
attribute name (without "data-")
- $value : string
-
attribute value
Return values
mixed —addElement()
Adds an element to the table. The element may be a htmlElement object or a simple String.
public
addElement(mixed $element[, bool $newLine = false ][, bool $isTableHeadElement = false ]) : mixed
Parameters
- $element : mixed
-
htmlElement object or a simple String
- $newLine : bool = false
-
adds a new line after the element (optional, default false)
- $isTableHeadElement : bool = false
-
specifies if this is a head or body element (default: body)
Return values
mixed —addNewLine()
Adds another line to the table.
public
addNewLine() : mixed
Return values
mixed —addSpace()
Adds an htmlSpacer with the given width.
public
addSpace(string $width) : mixed
Parameters
- $width : string
-
width (e.g. 10px)
Return values
mixed —addVerticalSpace()
Adds an htmlSpacer with the given height and ends the row.
public
addVerticalSpace(string $height) : mixed
Parameters
- $height : string
-
height (e.g. 10px)
Return values
mixed —generateHTML()
Prints the HTML code for this element.
public
generateHTML(string $module, array<string|int, mixed> $input, array<string|int, mixed> $values, bool $restricted, string $scope) : array<string|int, mixed>
Parameters
- $module : string
-
Name of account module
- $input : array<string|int, mixed>
-
List of meta-HTML elements
- $values : array<string|int, mixed>
-
List of values which override the defaults in $input (name => value)
- $restricted : bool
-
If true then no buttons will be displayed
- $scope : string
-
Account type
Return values
array<string|int, mixed> —List of input field names and their type (name => type)
getAccessibilityMarkup()
Returns the markup for the accessibility data.
public
getAccessibilityMarkup() : string
Return values
string —markup to be included in HTML tag (starting with space)
getAlignmentString()
Returns the HTML attributes for the alignment.
public
getAlignmentString() : string
Return values
string —alignment HTML attributes (e.g. align="right" valign="top")
getColspanString()
Returns the HTML attribute for the colspan.
public
getColspanString() : string
Return values
string —colspan HTML attribute (e.g. colspan=3)
getCSSClasses()
Returns the CSS classes of this element.
public
getCSSClasses() : array<string|int, mixed>
Return values
array<string|int, mixed> —$classes CSS class names
getRowspanString()
Returns the HTML attribute for the rowspan.
public
getRowspanString() : string
Return values
string —rowspan HTML attribute (e.g. rowspan=3)
getTableCellCSSClasses()
Returns the CSS classes of the surrounding table cell for this element.
public
getTableCellCSSClasses() : array<string|int, mixed>
Return values
array<string|int, mixed> —CSS classes
mergeTableElements()
Merges the content of another htmlTable object into this table.
public
mergeTableElements( $table) : mixed
Parameters
Return values
mixed —setAccessibilityLabel()
Sets the accessibility label.
public
setAccessibilityLabel(string|null $accessibilityLabel) : void
Parameters
- $accessibilityLabel : string|null
-
label
Return values
void —setCSSClasses()
Adds CSS classes to this element.
public
setCSSClasses(array<string|int, mixed> $classes) : mixed
Parameters
- $classes : array<string|int, mixed>
-
CSS class names
Return values
mixed —setTableCellCSSClasses()
Adds CSS classes to the surrounding table cell for this element.
public
setTableCellCSSClasses(array<string|int, mixed> $classes) : mixed
Parameters
- $classes : array<string|int, mixed>
-
CSS class names
Return values
mixed —getDataAttributesAsString()
Returns the data attributes as rendered string.
protected
getDataAttributesAsString() : string
Return values
string —data attributes