Creates a text area element.

package FormItBuilder

 Methods

FormItBuilder_elementTextArea

__construct(string $id, string $label, int $rows, int $cols, string $defaultValue) 

Creates a text area element.

Parameters

$id

string

ID of text area

$label

string

The label of text area

$rows

int

The required rows (attribute value that must be set on a valid XHTML textarea tag)

$cols

int

The required cols (attribute value that must be set on a valid XHTML textarea tag)

$defaultValue

string

The default text to be written into the text area

getDescription()

getDescription() : string
Inherited

Returns the form elements description.

inherited_from \FormItBuilder_element::getDescription()

Returns

string

getId()

getId() : string
Inherited

Returns the form elements ID.

inherited_from \FormItBuilder_element::getId()

Returns

string

getLabel()

getLabel() : string
Inherited

Returns the form elements label.

inherited_from \FormItBuilder_element::getLabel()

Returns

string

getName()

getName() : string
Inherited

Returns the form elements name.

inherited_from \FormItBuilder_element::getName()

Returns

string

isRequired($value) / isRequired()

isRequired(boolean $value) : boolean
Inherited

Sets wether the element is required or not.

This setting is generally toggled automatically based on FormRule settings applied in the form.

If no value passed the method will return the current required status.

inherited_from \FormItBuilder_element::isRequired()

Parameters

$value

boolean

If true the field must be filled out.

Returns

boolean

outputHTML()

outputHTML() : string

Outputs the HTML for the element.

Returns

string

setDescription($value)

setDescription(string $value) 
Inherited

Allows a sub label (or more descriptive label) to be set within the element label. Could be shown on hover or displayed with main label.

inherited_from \FormItBuilder_element::setDescription()

Parameters

$value

string

setId($value)

setId(string $value) 
Inherited

Sets the form elements ID.

inherited_from \FormItBuilder_element::setId()

Parameters

$value

string

setLabel($value)

setLabel(string $value) 
Inherited

Sets the form elements label.

inherited_from \FormItBuilder_element::setLabel()

Parameters

$value

string

setName($value)

setName(string $value) 
Inherited

Sets the form elements name.

inherited_from \FormItBuilder_element::setName()

Parameters

$value

string

showInEmail($value) / showInEmail()

showInEmail(boolean $value) : boolean
Inherited

Sets wether the element is shown in the email or not.

In some cases fields may be wanted in the form, but not in the email (an example would be fields like a "Confirm Password" field).

If no value passed the method will return the current status.

inherited_from \FormItBuilder_element::showInEmail()

Parameters

$value

boolean

If true (which is in most cases default) the element will be shown in the email.

Returns

boolean

showLabel($value) / showLabel()

showLabel(boolean $value) : boolean
Inherited

Sets wether the label should be displayed for this element or not. If no value passed the method will return the current status.

inherited_from \FormItBuilder_element::showLabel()

Parameters

$value

boolean

If true (which is in most cases default) a label will be shown next to the form element and in the email.

Returns

boolean