An extended input field that combines label, input field and help.

This is used to build HTML code by using objects.

package metaHTML

 Methods

Constructor

__construct(String $label, String $fieldName, String $fieldValue, String $helpID) 

Parameters

$label

String

descriptive label

$fieldName

String

unique field name

$fieldValue

String

value of input field (optional)

$helpID

String

help ID (optional)

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()
inherited_from \htmlInputField::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()
inherited_from \htmlInputField::getColspanString()

Returns

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

Returns the HTML attribute for the rowspan.

getRowspanString() : String
Inherited

inherited_from \htmlElement::getRowspanString()
inherited_from \htmlInputField::getRowspanString()

Returns

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

Sets the maximum field length.

setFieldMaxLength(int $fieldMaxLength) 
Inherited

inherited_from \htmlInputField::setFieldMaxLength()

Parameters

$fieldMaxLength

int

length

Sets the field size.

setFieldSize(int $fieldSize) 
Inherited

inherited_from \htmlInputField::setFieldSize()

Parameters

$fieldSize

int

size

Specifies if this component is enabled and accepts user modification.

setIsEnabled(boolean $isEnabled) 
Inherited

inherited_from \htmlInputField::setIsEnabled()

Parameters

$isEnabled

boolean

enabled if true

Specifies if this is a password field.

setIsPassword(boolean $isPassword) 
Inherited

inherited_from \htmlInputField::setIsPassword()

Parameters

$isPassword

boolean

password field

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

setObfuscate(boolean $obfuscate) 
Inherited

self service profile).

inherited_from \htmlInputField::setObfuscate()

Parameters

$obfuscate

boolean

obfuscate value

Specifies if the input field is required.

setRequired(boolean $required) 
Inherited

inherited_from \htmlInputField::setRequired()

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) 
Inherited

inherited_from \htmlInputField::setTransient()

Parameters

$transient

boolean

transient field

Specifies the validation rule (e.g.

setValidationRule(boolean $rule) 
Inherited

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

inherited_from \htmlInputField::setValidationRule()

Parameters

$rule

boolean

rule name

 Properties

 

alignment when inside a table

$alignment 
Inherited

inherited_from \htmlElement::$$alignment
inherited_from \htmlInputField::$$alignment
 

colspan if inside a table

$colspan 
Inherited

inherited_from \htmlElement::$$colspan
inherited_from \htmlInputField::$$colspan
 

rowspan if inside a table

$rowspan 
Inherited

inherited_from \htmlElement::$$rowspan
inherited_from \htmlInputField::$$rowspan
 

required field

$required 
Inherited

inherited_from \htmlInputField::$$required
 

field max length (default 255)

$fieldMaxLength 
Inherited

inherited_from \htmlInputField::$$fieldMaxLength
 

unique field name

$fieldName 
Inherited

inherited_from \htmlInputField::$$fieldName
 

field size (default 30)

$fieldSize 
Inherited

inherited_from \htmlInputField::$$fieldSize
 

field value

$fieldValue 
Inherited

inherited_from \htmlInputField::$$fieldValue
 

help ID

$helpID 

 

enabled or disabled

$isEnabled 
Inherited

inherited_from \htmlInputField::$$isEnabled
 

password field

$isPassword 
Inherited

inherited_from \htmlInputField::$$isPassword
 

Descriptive label

$label 

 

indicates that the value should be saved in obfuscated form

$obfuscate 
Inherited

inherited_from \htmlInputField::$$obfuscate
 

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

$transient 
Inherited

inherited_from \htmlInputField::$$transient
 

validation rule

$validationRule 
Inherited

inherited_from \htmlInputField::$$validationRule

 Constants

 

align to bottom

ALIGN_BOTTOM 
Inherited

inherited_from \htmlElement::ALIGN_BOTTOM
inherited_from \htmlInputField::ALIGN_BOTTOM
 

align to center

ALIGN_CENTER 
Inherited

inherited_from \htmlElement::ALIGN_CENTER
inherited_from \htmlInputField::ALIGN_CENTER
 

align to left

ALIGN_LEFT 
Inherited

inherited_from \htmlElement::ALIGN_LEFT
inherited_from \htmlInputField::ALIGN_LEFT
 

align to right

ALIGN_RIGHT 
Inherited

inherited_from \htmlElement::ALIGN_RIGHT
inherited_from \htmlInputField::ALIGN_RIGHT
 

align to top

ALIGN_TOP 
Inherited

inherited_from \htmlElement::ALIGN_TOP
inherited_from \htmlInputField::ALIGN_TOP
 

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

VALIDATE_NUMERIC 
Inherited

inherited_from \htmlElement::VALIDATE_NUMERIC
inherited_from \htmlInputField::VALIDATE_NUMERIC