LDAP Account Manager

htmlRadio extends htmlElement
in package

Represents a radio selection.

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  : 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
$tableRowsToHide  : mixed
list of enclosing table rows to hide when checked
$tableRowsToShow  : mixed
list of enclosing table rows to show when checked
$accessibilityLabel  : string|null
accessibility label
$dataAttributes  : mixed
data attributes
$elements  : mixed
elements
$isEnabled  : mixed
enabled or disabled
$name  : mixed
name of select field
$onchangeEvent  : mixed
on change code
$selectedElement  : mixed
selected element
__construct()  : mixed
Constructor.
addDataAttribute()  : mixed
Adds a data attribute.
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.
setAccessibilityLabel()  : void
Sets the accessibility label.
setCSSClasses()  : mixed
Adds CSS classes to this element.
setIsEnabled()  : mixed
Specifies if this component is enabled and accepts user modification.
setOnchangeEvent()  : mixed
Sets the JavaScript code for the onchange event.
setTableCellCSSClasses()  : mixed
Adds CSS classes to the surrounding table cell for this element.
setTableRowsToHide()  : mixed
This will hide the given table rows when the radio is changed to the specified value.
setTableRowsToShow()  : mixed
This will show the given table rows when the radio is changed to the specified value.
getDataAttributesAsString()  : string
Returns the data attributes as rendered string.
getShowHideSelector()  : string
Returns the selector to use to find the show/hide elements.
getOnchangeCodeForShowHideTableRows()  : string
Creates the JavaScript code to hide/show table rows based on the select value.
printInitialState()  : mixed

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 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 = []

$tableRowsToHide

list of enclosing table rows to hide when checked

protected mixed $tableRowsToHide = []

$tableRowsToShow

list of enclosing table rows to show when checked

protected mixed $tableRowsToShow = []

$accessibilityLabel

accessibility label

private string|null $accessibilityLabel = \null

$dataAttributes

data attributes

private mixed $dataAttributes = []

$elements

elements

private mixed $elements

$isEnabled

enabled or disabled

private mixed $isEnabled = \true

$name

name of select field

private mixed $name

$onchangeEvent

on change code

private mixed $onchangeEvent

$selectedElement

selected element

private mixed $selectedElement

Methods

__construct()

Constructor.

public __construct(string $name, array<string|int, mixed> $elements[, string $selectedElement = null ]) : mixed


Examples:

$radio = new htmlRadio('myName', array('label1' => 'value1', 'label2' => 'value2'), array('value1'));

Parameters
$name : string

element name

$elements : array<string|int, mixed>

list of elements array(label => value)

$selectedElement : string = null

value of selected element (optional, default none)

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 —

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

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 —

setIsEnabled()

Specifies if this component is enabled and accepts user modification.

public setIsEnabled(bool $isEnabled) : mixed
Parameters
$isEnabled : bool

enabled if true

Return values
mixed —

setOnchangeEvent()

Sets the JavaScript code for the onchange event.

public setOnchangeEvent(string $onchangeEvent) : mixed
Parameters
$onchangeEvent : string

onchange event code (e.g. myfunction();)

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 —

setTableRowsToHide()

This will hide the given table rows when the radio is changed to the specified value.

public setTableRowsToHide(array<string|int, mixed> $tableRowsToHide) : mixed

The given IDs can be of any e.g. input element. Starting from this element the first parent "" element will be used to show/hide.


Example for $tableRowsToHide:
array('val1' => array('option1', 'option2'), 'val2' => array('option3'))

Parameters
$tableRowsToHide : array<string|int, mixed>

array of select value => array of IDs of child elements to hide

Return values
mixed —

setTableRowsToShow()

This will show the given table rows when the radio is changed to the specified value.

public setTableRowsToShow(array<string|int, mixed> $tableRowsToShow) : mixed

The given IDs can be of any e.g. input element. Starting from this element the first parent "" element will be used to show/hide.


Example for $tableRowsToShow:
array('val1' => array('option1', 'option2'), 'val2' => array('option3'))

Parameters
$tableRowsToShow : array<string|int, mixed>

array of select value => array of IDs of child elements to show

Return values
mixed —

getDataAttributesAsString()

Returns the data attributes as rendered string.

protected getDataAttributesAsString() : string
Return values
string —

data attributes

getShowHideSelector()

Returns the selector to use to find the show/hide elements.

protected getShowHideSelector() : string
Return values
string —

selector

getOnchangeCodeForShowHideTableRows()

Creates the JavaScript code to hide/show table rows based on the select value.

private getOnchangeCodeForShowHideTableRows(int $counter) : string
Parameters
$counter : int

index

Return values
string —

onChange code

printInitialState()

private printInitialState() : mixed
Return values
mixed —

Search results