LDAP Account Manager

htmlResponsiveTable extends htmlElement
in package

Responsive table.

Tags
author

roland Gruber

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
$alignment  : int|null
alignment when inside a table
$colspan  : int|null
colspan if inside a table
$rowspan  : int|null
rowspan if inside a table
$cssClasses  : array<string|int, mixed>|null
$tableCellCssClasses  : array<string|int, mixed>|null
$accessibilityLabel  : string|null
accessibility label
$data  : array<string|int, mixed>
$dataAttributes  : array<string|int, mixed>
$highlighted  : array<string|int, mixed>
$onClick  : array<string|int, mixed>
$onDoubleClick  : array<string|int, mixed>
$titles  : array<string|int, mixed>
$widths  : array<string|int, mixed>
__construct()  : mixed
Creates the table.
addDataAttribute()  : void
Adds a data attribute.
generateHTML()  : array<string, string>
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, string>|null
Returns the CSS classes of this element.
getRowspanString()  : string
Returns the HTML attribute for the rowspan.
getTableCellCSSClasses()  : array<string|int, string>|null
Returns the CSS classes of the surrounding table cell for this element.
setAccessibilityLabel()  : void
Sets the accessibility label.
setCSSClasses()  : void
Adds CSS classes to this element.
setOnClickEvents()  : void
Sets the onclick code for the rows.
setOnDoubleClickEvents()  : void
Sets the ondoubleclick code for the rows.
setTableCellCSSClasses()  : void
Adds CSS classes to the surrounding table cell for this element.
setWidths()  : void
Sets the width of each column.
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

Properties

$alignment

alignment when inside a table

public int|null $alignment = \null

$colspan

colspan if inside a table

public int|null $colspan = \null

$rowspan

rowspan if inside a table

public int|null $rowspan = \null

$cssClasses

protected array<string|int, mixed>|null $cssClasses = []

CSS classes

$tableCellCssClasses

protected array<string|int, mixed>|null $tableCellCssClasses = []

table cell CSS classes

$accessibilityLabel

accessibility label

private string|null $accessibilityLabel = \null

$data

private array<string|int, mixed> $data

data rows

$dataAttributes

private array<string|int, mixed> $dataAttributes = []

data attributes

$highlighted

private array<string|int, mixed> $highlighted = []

highlighted rows

$onClick

private array<string|int, mixed> $onClick = []

onclick code (row number => code)

$onDoubleClick

private array<string|int, mixed> $onDoubleClick = []

ondoubleclick code (row number => code)

$titles

private array<string|int, mixed> $titles

row titles

$widths

private array<string|int, mixed> $widths = []

widths of the columns

Methods

__construct()

Creates the table.

public __construct(array<string|int, string> $titles, array<string|int, array<string|int, htmlElement>> $data[, array<string|int, int>|null $highlighted = null ]) : mixed
Parameters
$titles : array<string|int, string>

row titles

$data : array<string|int, array<string|int, htmlElement>>

data rows

$highlighted : array<string|int, int>|null = null

list of row numbers that should be highlighted (starting at 0)

Return values
mixed —

addDataAttribute()

Adds a data attribute.

public addDataAttribute(string $key, string $value) : void
Parameters
$key : string

attribute name (without "data-")

$value : string

attribute value

Return values
void —

generateHTML()

Prints the HTML code for this element.

public generateHTML(mixed $module, mixed $input, mixed $values, mixed $restricted) : array<string, string>
Parameters
$module : mixed

Name of account module

$input : mixed

List of meta-HTML elements

$values : mixed

List of values which override the defaults in $input (name => value)

$restricted : mixed

If true then no buttons will be displayed

Return values
array<string, string> —

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, string>|null
Return values
array<string|int, string>|null —

$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, string>|null
Return values
array<string|int, string>|null —

CSS classes

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, string>|null $classes) : void
Parameters
$classes : array<string|int, string>|null

CSS class names

Return values
void —

setOnClickEvents()

Sets the onclick code for the rows.

public setOnClickEvents(array<int, string> $calls) : void
Parameters
$calls : array<int, string>

row number => code

Return values
void —

setOnDoubleClickEvents()

Sets the ondoubleclick code for the rows.

public setOnDoubleClickEvents(array<int, string> $calls) : void
Parameters
$calls : array<int, string>

row number => code

Return values
void —

setTableCellCSSClasses()

Adds CSS classes to the surrounding table cell for this element.

public setTableCellCSSClasses(array<string|int, string>|null $classes) : void
Parameters
$classes : array<string|int, string>|null

CSS class names

Return values
void —

setWidths()

Sets the width of each column.

public setWidths(array<string|int, string> $widths) : void
Parameters
$widths : array<string|int, string>

widths

Return values
void —

getDataAttributesAsString()

Returns the data attributes as rendered string.

protected getDataAttributesAsString() : string
Return values
string —

data attributes

Search results