A standard input field.

This is used to build HTML code by using objects.

package metaHTML

 Methods

Constructor

__construct(String $fieldName, String $fieldValue, String $fieldSize) 

Parameters

$fieldName

String

unique field name

$fieldValue

String

value of input field (optional)

$fieldSize

String

maximum input length

Prints the HTML code for this element.

generateHTML(string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope) : array

Parameters

$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

Returns

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

Returns the HTML attributes for the alignment.

getAlignmentString() : String
Inherited

inherited_from \htmlElement::getAlignmentString()

Returns

Stringalignment HTML attributes (e.g. align="right" valign="top")

Returns the HTML attribute for the colspan.

getColspanString() : String
Inherited

inherited_from \htmlElement::getColspanString()

Returns

Stringcolspan HTML attribute (e.g. colspan=3)

Returns the HTML attribute for the rowspan.

getRowspanString() : String
Inherited

inherited_from \htmlElement::getRowspanString()

Returns

Stringrowspan HTML attribute (e.g. rowspan=3)

Sets the maximum field length.

setFieldMaxLength(int $fieldMaxLength) 

Parameters

$fieldMaxLength

int

length

Sets the field size.

setFieldSize(int $fieldSize) 

Parameters

$fieldSize

int

size

Specifies if this component is enabled and accepts user modification.

setIsEnabled(boolean $isEnabled) 

Parameters

$isEnabled

boolean

enabled if true

Specifies if this is a password field.

setIsPassword(boolean $isPassword) 

Parameters

$isPassword

boolean

password field

Specifies if the value should be saved in obfuscated form (e.g.

setObfuscate(boolean $obfuscate) 

self service profile).

Parameters

$obfuscate

boolean

obfuscate value

Specifies if the input field is required.

setRequired(boolean $required) 

Parameters

$required

boolean

required

Specifies that the value should not be automatically saved when used in self service or server profile (default: false).

setTransient(boolean $transient) 

Parameters

$transient

boolean

transient field

Specifies the validation rule (e.g.

setValidationRule(boolean $rule) 

htmlElement::VALIDATE_NUMERIC) for this field. This rule is checked on client side when the input field looses focus.

Parameters

$rule

boolean

rule name

 Properties

 

alignment when inside a table

$alignment 
Inherited

inherited_from \htmlElement::$$alignment
 

colspan if inside a table

$colspan 
Inherited

inherited_from \htmlElement::$$colspan
 

rowspan if inside a table

$rowspan 
Inherited

inherited_from \htmlElement::$$rowspan
 

required field

$required 

 

field max length (default 255)

$fieldMaxLength 

 

unique field name

$fieldName 

 

field size (default 30)

$fieldSize 

 

field value

$fieldValue 

 

enabled or disabled

$isEnabled 

 

password field

$isPassword 

 

indicates that the value should be saved in obfuscated form

$obfuscate 

 

indicates that this field should not automatically be saved in the self service or server profile

$transient 

 

validation rule

$validationRule 

 Constants

 

align to bottom

ALIGN_BOTTOM 
Inherited

inherited_from \htmlElement::ALIGN_BOTTOM
 

align to center

ALIGN_CENTER 
Inherited

inherited_from \htmlElement::ALIGN_CENTER
 

align to left

ALIGN_LEFT 
Inherited

inherited_from \htmlElement::ALIGN_LEFT
 

align to right

ALIGN_RIGHT 
Inherited

inherited_from \htmlElement::ALIGN_RIGHT
 

align to top

ALIGN_TOP 
Inherited

inherited_from \htmlElement::ALIGN_TOP
 

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

VALIDATE_NUMERIC 
Inherited

inherited_from \htmlElement::VALIDATE_NUMERIC