LDAP Account Manager

htmlResponsiveInputTextarea extends htmlInputTextarea
in package

Responsive text area with label and help link.

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
VALIDATE_NUMERIC  = 'numeric'
validation rule to allow only numbers ([0-9]+)
VALIDATE_NUMERIC_WITH_NEGATIVE  = 'numericWithNegative'
validation rule to allow positive/negative numbers ([-]?[0-9]+)
$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
$required  : mixed
required field
$richEdit  : mixed
specifies if LAM should display this field with a WYSIWYG editor
$tableCellCssClasses  : mixed
table cell CSS classes
$colCount  : mixed
column count
$dataAttributes  : mixed
data attributes
$helpID  : mixed
help ID
$helpModule  : mixed
help module
$isEnabled  : mixed
enabled or disabled
$label  : mixed
descriptive label
$name  : mixed
unique name of input element
$renderParentHtml  : mixed
render HTML of parent class
$rowCount  : mixed
row count
$value  : mixed
value
__construct()  : mixed
Constructor.
addDataAttribute()  : mixed
Adds a data attribute.
generateHTML()  : array<string|int, mixed>
Prints the HTML code for this element.
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.
setCSSClasses()  : mixed
Adds CSS classes to this element.
setIsEnabled()  : mixed
Specifies if this component is enabled and accepts user modification.
setIsRichEdit()  : mixed
Specifies if the textarea should be displayed with a WYSIWYG editor.
setRequired()  : mixed
Specifies if the input field is required.
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

VALIDATE_NUMERIC

validation rule to allow only numbers ([0-9]+)

public mixed VALIDATE_NUMERIC = 'numeric'

VALIDATE_NUMERIC_WITH_NEGATIVE

validation rule to allow positive/negative numbers ([-]?[0-9]+)

public mixed VALIDATE_NUMERIC_WITH_NEGATIVE = 'numericWithNegative'

Properties

$alignment

alignment when inside a table

public mixed $alignment = \null

$colspan

colspan if inside a table

public mixed $colspan = \null

$rowspan

rowspan if inside a table

public mixed $rowspan = \null

$cssClasses

CSS classes

protected mixed $cssClasses = array()

$required

required field

protected mixed $required = \false

$richEdit

specifies if LAM should display this field with a WYSIWYG editor

protected mixed $richEdit = \false

$tableCellCssClasses

table cell CSS classes

protected mixed $tableCellCssClasses = array()

$colCount

column count

private mixed $colCount

$dataAttributes

data attributes

private mixed $dataAttributes = array()

$helpID

help ID

private mixed $helpID

$helpModule

help module

private mixed $helpModule = \null

$isEnabled

enabled or disabled

private mixed $isEnabled = \true

$label

descriptive label

private mixed $label

$name

unique name of input element

private mixed $name

$renderParentHtml

render HTML of parent class

private mixed $renderParentHtml = \false

$rowCount

row count

private mixed $rowCount

$value

value

private mixed $value

Methods

__construct()

Constructor.

public __construct(string $name, string $value, int $colCount, int $rowCount, string $label[, string|array<string|int, mixed> $helpID = null ]) : mixed
Parameters
$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|array<string|int, mixed> = null

help ID

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(mixed $module, mixed $input, mixed $values, mixed $restricted, mixed &$tabindex, mixed $scope) : array<string|int, mixed>
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

$tabindex : mixed

Start value of tabulator index for input fields

$scope : mixed

Account type

Tags
see
htmlInputField::generateHTML()
Return values
array<string|int, mixed>

List of input field names and their type (name => type)

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

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

setIsRichEdit()

Specifies if the textarea should be displayed with a WYSIWYG editor.

public setIsRichEdit(bool $richEdit) : mixed


This requires that the page which displays the textarea also includes the ckeditor JS.
Rich editing is disabled by default.

Parameters
$richEdit : bool

rich edit or standard

Return values
mixed

setRequired()

Specifies if the input field is required.

public setRequired(bool $required) : mixed
Parameters
$required : bool

required

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

Search results