lib/html.inc
Properties
Description
Interface between modules and other parts of LAM.Classes
htmlElement
Description
Represents a HTML element.This is used to build HTML code by using objects.
Methods
generateHTML, getAlignmentString, getColspanString, getRowspanString, getTableCellCSSClasses, setCSSClasses, setTableCellCSSClasses,generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
getAlignmentString( ) : String
Description
Returns the HTML attributes for the alignment.Return value
Type | Description |
---|---|
String | alignment HTML attributes (e.g. align="right" valign="top") |
getColspanString( ) : String
Description
Returns the HTML attribute for the colspan.Return value
Type | Description |
---|---|
String | colspan HTML attribute (e.g. colspan=3) |
getRowspanString( ) : String
Description
Returns the HTML attribute for the rowspan.Return value
Type | Description |
---|---|
String | rowspan HTML attribute (e.g. rowspan=3) |
getTableCellCSSClasses( ) : array
Description
Returns the CSS classes of the surrounding table cell for this element.Return value
Type | Description |
---|---|
array | CSS classes |
Constants
ALIGN_BOTTOM = 3
align to bottomALIGN_CENTER = 4
align to centerALIGN_LEFT = 1
align to leftALIGN_RIGHT = 2
align to rightALIGN_TOP = 0
align to topVALIDATE_NUMERIC = 'numeric'
validation rule to allow only numbers ([0-9]+)VALIDATE_NUMERIC_WITH_NEGATIVE = 'numericWithNegative'
validation rule to allow positive/negative numbers ([-]?[0-9]+)htmlTable
Description
Structures elements using a table.This is used to build HTML code by using objects.
Methods
__construct, addElement, addNewLine, addSpace, addVerticalSpace, generateHTML, mergeTableElements,__construct( String $width = null, $id = null, ) : n/a
Description
ConstructorArguments
Name | Type | Description | Default |
---|---|---|---|
$width | String | table width (e.g. 100%) |
null |
$id | n/a | null |
Return value
Type | Description |
---|---|
n/a | n/a |
Tags
Name | Description |
---|---|
see |
addElement( mixed $element, boolean $newLine = false, boolean $isTableHeadElement = false, ) : n/a
Description
Adds an element to the table. The element may be a htmlElement object or a simple String.Arguments
Name | Type | Description | Default |
---|---|---|---|
$element | mixed | htmlElement object or a simple String |
|
$newLine | boolean | adds a new line after the element (optional, default false) |
false |
$isTableHeadElement | boolean | specifies if this is a head or body element (default: body) |
false |
Return value
Type | Description |
---|---|
n/a | n/a |
addNewLine( ) : n/a
Description
Adds another line to the table.Return value
Type | Description |
---|---|
n/a | n/a |
addSpace( String $width, ) : n/a
Description
Adds an htmlSpacer with the given width.Arguments
Name | Type | Description | Default |
---|---|---|---|
$width | String | width (e.g. 10px) |
Return value
Type | Description |
---|---|
n/a | n/a |
addVerticalSpace( String $height, ) : n/a
Description
Adds an htmlSpacer with the given height and ends the row.Arguments
Name | Type | Description | Default |
---|---|---|---|
$height | String | height (e.g. 10px) |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlTableRow
Description
A row inside a htmlTable.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( array $cells, ) : n/a
Description
ConstructorArguments
Name | Type | Description | Default |
---|---|---|---|
$cells | array | list of htmlElements |
Return value
Type | Description |
---|---|
n/a | n/a |
Tags
Name | Description |
---|---|
see |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlInputField
Description
A standard input field.This is used to build HTML code by using objects.
Methods
__construct, enableAutocompletion, generateHTML, setFieldMaxLength, setFieldSize, setIsEnabled, setIsPassword, setObfuscate, setOnKeyPress, setRequired, setTitle, setTransient, setValidationRule, showCalendar,__construct( String $fieldName, String $fieldValue = null, String $fieldSize = null, ) : n/a
Description
ConstructorArguments
Name | Type | Description | Default |
---|---|---|---|
$fieldName | String | unique field name |
|
$fieldValue | String | value of input field (optional) |
null |
$fieldSize | String | maximum input length |
null |
Return value
Type | Description |
---|---|
n/a | n/a |
enableAutocompletion( array $values, int $minLength = 1, boolean $multiValue = false, $multiSeparatorExp = ',\s*', String|String $multiSeparator = ', ', ) : n/a
Description
Enables autocompletion for this input field.Arguments
Name | Type | Description | Default |
---|---|---|---|
$values | array | list of values to suggest |
|
$minLength | int | autocompletion starts after this number of caracters entered (default 1; 0 means immediate start) |
1 |
$multiValue | boolean | allow multiple autocompletion values in the same fields (default: false) |
false |
$multiSeparatorExp | n/a | ',\s*' | |
$multiSeparator | String|String | separator expression if multiple autocompletion values are allowed (default ",\s*") |
', ' |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
setFieldMaxLength( int $fieldMaxLength, ) : n/a
Description
Sets the maximum field length.Arguments
Name | Type | Description | Default |
---|---|---|---|
$fieldMaxLength | int | length |
Return value
Type | Description |
---|---|
n/a | n/a |
setFieldSize( int $fieldSize, ) : n/a
Description
Sets the field size.Arguments
Name | Type | Description | Default |
---|---|---|---|
$fieldSize | int | size |
Return value
Type | Description |
---|---|
n/a | n/a |
setIsEnabled( boolean $isEnabled, ) : n/a
Description
Specifies if this component is enabled and accepts user modification.Arguments
Name | Type | Description | Default |
---|---|---|---|
$isEnabled | boolean | enabled if true |
Return value
Type | Description |
---|---|
n/a | n/a |
setIsPassword( boolean $isPassword, ) : n/a
Description
Specifies if this is a password field.Arguments
Name | Type | Description | Default |
---|---|---|---|
$isPassword | boolean | password field |
Return value
Type | Description |
---|---|
n/a | n/a |
setObfuscate( boolean $obfuscate, ) : n/a
Description
Specifies if the value should be saved in obfuscated form (e.g. self service profile).Arguments
Name | Type | Description | Default |
---|---|---|---|
$obfuscate | boolean | obfuscate value |
Return value
Type | Description |
---|---|
n/a | n/a |
setOnKeyPress( String $onKeyPress, ) : n/a
Description
Sets the JavaScript for the onKeyPress event.Arguments
Name | Type | Description | Default |
---|---|---|---|
$onKeyPress | String | JavaScript code |
Return value
Type | Description |
---|---|
n/a | n/a |
setRequired( boolean $required, ) : n/a
Description
Specifies if the input field is required.Arguments
Name | Type | Description | Default |
---|---|---|---|
$required | boolean | required |
Return value
Type | Description |
---|---|
n/a | n/a |
setTitle( String $title, ) : n/a
Description
Sets the title for the input field.Arguments
Name | Type | Description | Default |
---|---|---|---|
$title | String | title value |
Return value
Type | Description |
---|---|
n/a | n/a |
setTransient( boolean $transient, ) : n/a
Description
Specifies that the value should not be automatically saved when used in self service or server profile (default: false).Arguments
Name | Type | Description | Default |
---|---|---|---|
$transient | boolean | transient field |
Return value
Type | Description |
---|---|
n/a | n/a |
setValidationRule( boolean $rule, ) : n/a
Description
Specifies the validation rule (e.g. htmlElement::VALIDATE_NUMERIC) for this field.This rule is checked on client side when the input field looses focus.
Arguments
Name | Type | Description | Default |
---|---|---|---|
$rule | boolean | rule name |
Return value
Type | Description |
---|---|
n/a | n/a |
Properties
$autocomplete, $autocompleteMinLength, $autocompleteMultiValue, $autocompleteMultiValueSeparator, $autocompleteMultiValueSeparatorExp, $autocompleteValues, $calendarFormat, $fieldMaxLength, $fieldName, $fieldSize, $fieldValue, $isEnabled, $isPassword, $obfuscate, $onKeyPress, $required, $showCalendar, $title, $transient, $validationRule,protected $autocompleteMultiValueSeparatorExp = null
separator expression for multiple values in one fieldhtmlTableExtendedInputField
Description
An extended input field that combines label, input field and help.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $label, String $fieldName, String $fieldValue = null, String $helpID = null, ) : n/a
Description
ConstructorArguments
Name | Type | Description | Default |
---|---|---|---|
$label | String | descriptive label |
|
$fieldName | String | unique field name |
|
$fieldValue | String | value of input field (optional) |
null |
$helpID | String | help ID (optional) |
null |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlHelpLink
Description
Renders a help link.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $helpID, String $module = null, String $scope = null, ) : n/a
Description
ConstructorArguments
Name | Type | Description | Default |
---|---|---|---|
$helpID | String | help ID |
|
$module | String | module name (optional, only if value from generateHTML() should be overwritten) |
null |
$scope | String | account type (e.g. user) (optional, only if value from generateHTML() should be overwritten) |
null |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlButton
Description
Simple button.This is used to build HTML code by using objects.
Methods
__construct, generateHTML, setIconClass, setIsEnabled, setOnClick, setTitle, setType,__construct( String $name, String $value, String $isImageButton = false, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$name | String | button name |
|
$value | String | button text or image (16x16px, relative to graphics folder) |
|
$isImageButton | String | image or text button (default text) |
false |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
setIconClass( String $iconClass, ) : n/a
Description
Sets an additional icon for a text button.The icon class is a CSS class that specifies the icon image (e.g. "deleteButton" in layout.css).
Arguments
Name | Type | Description | Default |
---|---|---|---|
$iconClass | String | icon class |
Return value
Type | Description |
---|---|
n/a | n/a |
setIsEnabled( boolean $isEnabled, ) : n/a
Description
Specifies if this component is enabled and accepts user modification.Arguments
Name | Type | Description | Default |
---|---|---|---|
$isEnabled | boolean | enabled if true |
Return value
Type | Description |
---|---|
n/a | n/a |
setOnClick( String $onClick, ) : n/a
Description
Sets the onclick event code.This makes this button a simple button that does not submit a form.
Arguments
Name | Type | Description | Default |
---|---|---|---|
$onClick | String | JS code |
Return value
Type | Description |
---|---|
n/a | n/a |
htmlAccountPageButton
Description
Prints a button for the account pages.This is used to build HTML code by using objects.
Methods
__construct,__construct( String $targetModule, String $targetPage, String $identifier, String $value, String $isImageButton = false, ) : n/a
Description
ConstructorArguments
Name | Type | Description | Default |
---|---|---|---|
$targetModule | String | module name which renders next page |
|
$targetPage | String | name of next page |
|
$identifier | String | identifier for button |
|
$value | String | button text or image (16x16px, relative to graphics folder) |
|
$isImageButton | String | image or text button (default text) |
false |
Return value
Type | Description |
---|---|
n/a | n/a |
htmlSelect
Description
Represents a select box.This is used to build HTML code by using objects.
Methods
__construct, generateHTML, printCodeForShowHideTableRows, printOptionsHTML, setContainsOptgroups, setHasDescriptiveElements, setIsEnabled, setMultiSelect, setOnchangeEvent, setRightToLeftTextDirection, setSortElements, setTableRowsToHide, setTableRowsToShow, setTransformSingleSelect, setTransient, setWidth,__construct( String $name, array $elements, array $selectedElements = array(), int $size = 1, ) : n/a
Description
Constructor.Examples:
$select = new htmlSelect('myName', array('value1', 'value2'), array('value1'));
$select = new htmlSelect('myName', array('label1' => 'value1', 'label2' => 'value2'), array('value1'));
$select->setHasDescriptiveElements(true);
$select = new htmlSelect('myName', array('optgroupLabel' => array('value1', 'value2')), array('value1'));
$select->setHasDescriptiveElements(true);
$select->setContainsOptgroups(true);
Arguments
Name | Type | Description | Default |
---|---|---|---|
$name | String | element name |
|
$elements | array | list of elements array(label => value) or array(value1, value2) or array('optgroup' => array(...)) |
|
$selectedElements | array | list of selected elements (optional, default none) |
array() |
$size | int | size (optional, default = 1) |
1 |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
printCodeForShowHideTableRows( String $onChange, ) : n/a
Description
Creates the JavaScript code to hide/show table rows based on the select value.Arguments
Name | Type | Description | Default |
---|---|---|---|
$onChange | String | onChange code |
Return value
Type | Description |
---|---|
n/a | n/a |
printOptionsHTML( array $elements, ) : n/a
Description
Prints the HTML code of the option tags.Arguments
Name | Type | Description | Default |
---|---|---|---|
$elements | array | list of options |
Return value
Type | Description |
---|---|
n/a | n/a |
setContainsOptgroups( boolean $containsOptgroups, ) : n/a
Description
Specifies if the elements are divided into optgroups.Arguments
Name | Type | Description | Default |
---|---|---|---|
$containsOptgroups | boolean | activates optgroups |
Return value
Type | Description |
---|---|
n/a | n/a |
setHasDescriptiveElements( boolean $hasDescriptiveElements, ) : n/a
Description
Specifies if the elements are just a simple list or an assoziative array (default: simple list).Arguments
Name | Type | Description | Default |
---|---|---|---|
$hasDescriptiveElements | boolean | activates descriptive elements |
Return value
Type | Description |
---|---|
n/a | n/a |
setIsEnabled( boolean $isEnabled, ) : n/a
Description
Specifies if this component is enabled and accepts user modification.Arguments
Name | Type | Description | Default |
---|---|---|---|
$isEnabled | boolean | enabled if true |
Return value
Type | Description |
---|---|
n/a | n/a |
setMultiSelect( boolean $multiSelect, ) : n/a
Description
Specifies if multi-selection is enabled (default: disabled).Arguments
Name | Type | Description | Default |
---|---|---|---|
$multiSelect | boolean | allows multi-selection |
Return value
Type | Description |
---|---|
n/a | n/a |
setOnchangeEvent( String $onchangeEvent, ) : n/a
Description
Sets the JavaScript code for the onchange event.Arguments
Name | Type | Description | Default |
---|---|---|---|
$onchangeEvent | String | onchange event code (e.g. myfunction();) |
Return value
Type | Description |
---|---|
n/a | n/a |
setRightToLeftTextDirection( boolean $rightToLeftTextDirection, ) : n/a
Description
Specifies if the text direction should be set to right to left.Arguments
Name | Type | Description | Default |
---|---|---|---|
$rightToLeftTextDirection | boolean | if true use right to left direction |
Return value
Type | Description |
---|---|
n/a | n/a |
setSortElements( boolean $sortElements, ) : n/a
Description
Specifies if the elemets should be sorted (default: sort).Arguments
Name | Type | Description | Default |
---|---|---|---|
$sortElements | boolean | sort elements |
Return value
Type | Description |
---|---|
n/a | n/a |
setTableRowsToHide( array $tableRowsToHide, ) : n/a
Description
This will hide the given table rows when the select is changed to the specified value.The given IDs can be of any e.g. input element. Starting from this element the first parent "
Example:
Using "mycheckbox" will use this "tr" to hide/show.
Example for $tableRowsToHide:
array('yes' => array('option1', 'option2'), 'no' => array('option3'))
Arguments
Name | Type | Description | Default |
---|---|---|---|
$tableRowsToHide | array | array of select value => array of IDs of child elements to hide |
Return value
Type | Description |
---|---|
n/a | n/a |
setTableRowsToShow( array $tableRowsToShow, ) : n/a
Description
This will show the given table rows when the select is changed to the specified value.The given IDs can be of any e.g. input element. Starting from this element the first parent "
Example:
Using "mycheckbox" will use this "tr" to hide/show.
Example for $tableRowsToShow:
array('yes' => array('option1', 'option2'), 'no' => array('option3'))
Arguments
Name | Type | Description | Default |
---|---|---|---|
$tableRowsToShow | array | array of select value => array of IDs of child elements to show |
Return value
Type | Description |
---|---|
n/a | n/a |
setTransformSingleSelect( boolean $transformSingleSelect, ) : n/a
Description
Specifies if select boxes that contain only a single element should be transformed to a simple text field.Arguments
Name | Type | Description | Default |
---|---|---|---|
$transformSingleSelect | boolean | transform single options to text |
Return value
Type | Description |
---|---|
n/a | n/a |
Properties
$containsOptgroups, $elements, $hasDescriptiveElements, $isEnabled, $multiSelect, $name, $onchangeEvent, $rightToLeftTextDirection, $selectedElements, $size, $sortElements, $tableRowsToHide, $tableRowsToShow, $transformSingleSelect, $transient, $width,htmlTableExtendedSelect
Description
Select with label and help link.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $name, array $elements, array $selectedElements, String $label, String $helpID = null, int $size = 1, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$name | String | element name |
|
$elements | array | list of elememts |
|
$selectedElements | array | list of selected elements |
|
$label | String | descriptive label |
|
$helpID | String | help ID (optional, default none) |
null |
$size | int | size (optional, default = 1) |
1 |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlRadio
Description
Represents a radio selection.This is used to build HTML code by using objects.
Methods
__construct, generateHTML, setIsEnabled, setOnchangeEvent,__construct( String $name, array $elements, String $selectedElement = null, ) : n/a
Description
Constructor.Examples:
$radio = new htmlRadio('myName', array('label1' => 'value1', 'label2' => 'value2'), array('value1'));
Arguments
Name | Type | Description | Default |
---|---|---|---|
$name | String | element name |
|
$elements | array | list of elements array(label => value) |
|
$selectedElement | String | value of selected element (optional, default none) |
null |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlTableExtendedRadio
Description
Radio list with descriptive label and help link.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $label, String $name, array $elements, String $selectedElement = null, String $helpID = null, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$label | String | descriptive label |
|
$name | String | element name |
|
$elements | array | list of elements array(label => value) |
|
$selectedElement | String | value of selected element (optional, default none) |
null |
$helpID | String | help ID |
null |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlOutputText
Description
Prints the text and escapes contained HTML code by default.This is used to build HTML code by using objects.
Methods
__construct, generateHTML, setIsBold, setMarkAsRequired, setNoWrap,__construct( String $string, boolean $escapeHTML = true, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$string | String | output text |
|
$escapeHTML | boolean | escape HTML code (default yes) |
true |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
setIsBold( boolean $isBold, ) : n/a
Description
Specifies if the whole text should be printed in bold.Arguments
Name | Type | Description | Default |
---|---|---|---|
$isBold | boolean | bold text |
Return value
Type | Description |
---|---|
n/a | n/a |
htmlInputCheckbox
Description
Prints the HTML code for a checkbox.This is used to build HTML code by using objects.
Methods
__construct, generateHTML, setIsEnabled, setTableRowsToHide, setTableRowsToShow, setTransient,__construct( String $name, boolean $checked, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$name | String | unique name |
|
$checked | boolean | checked |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
setIsEnabled( boolean $isEnabled, ) : n/a
Description
Specifies if this component is enabled and accepts user modification.Arguments
Name | Type | Description | Default |
---|---|---|---|
$isEnabled | boolean | enabled if true |
Return value
Type | Description |
---|---|
n/a | n/a |
setTableRowsToHide( array $tableRowsToHide, ) : n/a
Description
This will hide the given table rows when the checkbox is checked.The given IDs can be of any e.g. input element. Starting from this element the first parent "
Example:
Using "mycheckbox" will use this "tr" to hide/show.
Arguments
Name | Type | Description | Default |
---|---|---|---|
$tableRowsToHide | array | IDs of child elements to hide |
Return value
Type | Description |
---|---|
n/a | n/a |
setTableRowsToShow( array $tableRowsToShow, ) : n/a
Description
This will show the given table rows when the checkbox is checked.The given IDs can be of any e.g. input element. Starting from this element the first parent "
Example:
Using "mycheckbox" will use this "tr" to hide/show.
Arguments
Name | Type | Description | Default |
---|---|---|---|
$tableRowsToShow | array | IDs of child elements to show |
Return value
Type | Description |
---|---|
n/a | n/a |
htmlTableExtendedInputCheckbox
Description
Checkbox with descriptive label and help link.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $name, boolean $checked, String $label, String $helpID = null, boolean $labelFirst = true, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$name | String | unique name |
|
$checked | boolean | checked |
|
$label | String | descriptive label |
|
$helpID | String | help ID |
null |
$labelFirst | boolean | specifies if the label is at the beginning or at the end (optional, default beginning) |
true |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlInputFileUpload
Description
Prints the HTML code for a file upload field.This is used to build HTML code by using objects.
Methods
__construct, generateHTML, setIsEnabled,__construct( String $name, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$name | String | unique name |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlTableExtendedInputFileUpload
Description
File upload with descriptive label and help link.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $name, String $label, String $helpID = null, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$name | String | unique name |
|
$label | String | descriptive label |
|
$helpID | String | help ID |
null |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlInputTextarea
Description
Prints the HTML code for a textarea.This is used to build HTML code by using objects.
Methods
__construct, generateHTML, setIsEnabled, setIsRichEdit,__construct( String $name, String $value, int $colCount, int $rowCount, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$name | String | unique name |
|
$value | String | value |
|
$colCount | int | number of characters per line |
|
$rowCount | int | number of rows |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
setIsEnabled( boolean $isEnabled, ) : n/a
Description
Specifies if this component is enabled and accepts user modification.Arguments
Name | Type | Description | Default |
---|---|---|---|
$isEnabled | boolean | enabled if true |
Return value
Type | Description |
---|---|
n/a | n/a |
setIsRichEdit( boolean $richEdit, ) : n/a
Description
Specifies if the textarea should be displayed whith a WYSIWYG editor.This requires that the page which displays the textarea also includes the ckeditor JS.
Rich editing is disabled by default.
Arguments
Name | Type | Description | Default |
---|---|---|---|
$richEdit | boolean | rich edit or standard |
Return value
Type | Description |
---|---|
n/a | n/a |
htmlTableExtendedInputTextarea
Description
Text area with label and help link.This is used to build HTML code by using objects.
Methods
__construct, generateHTML, setRequired,__construct( String $name, String $value, int $colCount, int $rowCount, String $label, String $helpID = null, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$name | String | unique name |
|
$value | String | value |
|
$colCount | int | number of characters per line |
|
$rowCount | int | number of rows |
|
$label | String | descriptive label |
|
$helpID | String | help ID |
null |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlImage
Description
Prints the HTML code for an image.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $path, int $width = null, int $height = null, String $alt = ' ', ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$path | String | image location |
|
$width | int | image width (optional, default original size) |
null |
$height | int | image height (optional, default original size) |
null |
$alt | String | alt text (optional) |
' ' |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlSpacer
Description
Adds an empty space with given width and height.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $width, String $height, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$width | String | width (e.g. 10px) |
|
$height | String | height (e.g. 10px) |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlStatusMessage
Description
Prints a status message (e.g. error message).This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $type, String $title, String $text = null, array $params = null, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$type | String | message type (e.g. ERROR) |
|
$title | String | message title |
|
$text | String | message (optional) |
null |
$params | array | additional message parameters |
null |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlFieldset
Description
Generates a fieldset.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( \htmlElement $content, String $label = null, String $labelImage = null, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$content | \htmlElement | content to display inside fieldset |
|
$label | String | label |
null |
$labelImage | String | image to put before label |
null |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlTitle
Description
Generates a title line. This is used for page titles.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $label, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$label | String | label |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlSubTitle
Description
Generates a subtitle line. This is used to group multiple fields.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $label, String $image = null, String $id = null, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$label | String | label |
|
$image | String | optional image |
null |
$id | String | optional ID for this element (e.g. to use for JavaScript) |
null |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlHiddenInput
Description
Generates a hidden input field.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $name, String $value, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$name | String | input name |
|
$value | String | input value |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlLink
Description
Generates a link.The link can include an optional image in front of the link text.
Methods
__construct, generateHTML, setOnClick, setTargetWindow, setTitle,__construct( String $text, String $target, String $image = null, boolean $showAsButton = false, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$text | String | label |
|
$target | String | target URL |
|
$image | String | URL of optional image |
null |
$showAsButton | boolean | shows this like as a button |
false |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
setOnClick( String $event, ) : n/a
Description
Sets the onClick event.Arguments
Name | Type | Description | Default |
---|---|---|---|
$event | String | JavaScript code |
Return value
Type | Description |
---|---|
n/a | n/a |
htmlGroup
Description
Groups multiple htmlElements.This is useful if multiple elements should be included in a single table cell. The HTML code of the subelements is printed in the order they were added. No additional code is added.
Methods
addElement, generateHTML,addElement( \htmlElement $sub, ) : n/a
Description
Adds a subelement.Arguments
Name | Type | Description | Default |
---|---|---|---|
$sub | \htmlElement | subelement |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlHorizontalLine
Description
Prints a horizontal line.This is used to build HTML code by using objects.
Methods
generateHTML,generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlDiv
Description
Creates a simple DIV element.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $id, \htmlElement $content, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$id | String | unique ID |
|
$content | \htmlElement | inner content |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlJavaScript
Description
Creates a JavaScript element.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( String $content, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$content | String | script |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlEqualWidth
Description
Sets all given elements to the same width.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( array $elements, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$elements | array | list of element IDs |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlEqualHeight
Description
Sets all given elements to the same height.This is used to build HTML code by using objects.
Methods
__construct, generateHTML,__construct( array $elements, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$elements | array | list of element IDs |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
htmlSortableList
Description
Creates a list of elements that can be sorted by the user via drag'n'drop.This is used to build HTML code by using objects.
Methods
__construct, generateHTML, setOnUpdate,__construct( array $elements, $id, String $elementWidth = '250px', ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$elements | array | list of element IDs (HTML special chars must be escaped already) |
|
$id | n/a | ||
$elementWidth | String | width of elements (default 250px) |
'250px' |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |
setOnUpdate( String $onUpdate, ) : n/a
Description
Sets the JS code that is executed when the element order was changed.The code can access the variables event and ui. See JQueryUI docs for details. ui.item.data('posOrig') will contain the original position of the moved element.
Arguments
Name | Type | Description | Default |
---|---|---|---|
$onUpdate | String | JS code |
Return value
Type | Description |
---|---|
n/a | n/a |
htmlAccordion
Properties
Description
Creates a list of content elements in accordion style.HTML special characters must be escaped before providing to htmlAccordion.
Methods
__construct, generateHTML,__construct( String $id, array $elements, String $openInitial = '0', boolean $collapsible = false, ) : n/a
Description
Constructor.Arguments
Name | Type | Description | Default |
---|---|---|---|
$id | String | HTML ID |
|
$elements | array | list of content elements array('title' => htmlElement) |
|
$openInitial | String | index of element that is initially opened (default: 0), set to 'false' to close all |
'0' |
$collapsible | boolean | specifies if all elements may be closed at the same time (default: false, true if $openInitial is false) |
false |
Return value
Type | Description |
---|---|
n/a | n/a |
generateHTML( string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope, ) : array
Description
Prints the HTML code for this element.Arguments
Name | Type | Description | Default |
---|---|---|---|
$module | string | Name of account module |
|
$input | array | List of meta-HTML elements |
|
$values | array | List of values which override the defaults in $input (name => value) |
|
$restricted | boolean | If true then no buttons will be displayed |
|
$tabindex | integer | Start value of tabulator index for input fields |
|
$scope | string | Account type |
Return value
Type | Description |
---|---|
array | List of input field names and their type (name => type) |