Class: InputHidden

FormElement::__construct(): General abstract, hidden formelement constructor.
FormElement::addCssClasses(): Adds one or many css-classes to the element's class-attribute.
FormElement::addElement(): Adds a subelement to the element.
FormElement::determineRefiller(): Returns the supposed source of refill values.
FormElement::doRender(): Returns the compiled html-code for the element.
FormElement::getId(): Return the element's html-id.
FormElement::getLabel(): Return the element's label text.
FormElement::getMasterElement(): Return the currently connected owner element for the element.
FormElement::getMasterForm(): Returns the currently connected owner form for the element.
FormElement::getName(): Return the element's html-name.
FormElement::getSubElements(): Return all owned elements of this element.
FormElement::getTitle(): Return the element's html-title.
FormElement::getValidator(): Return the currently connected validator for the element.
FormElement::getValue(): Returns the value of the element if there is any.
FormElement::getValueSet(): Returns the compiled valueset for this element including the elements owned by this one.
FormElement::insertElementAfter(): Searches the subelements of the element if present and inserts a given element after the first found one.
FormElement::isValid(): Answers if the element is in a valid state at the moment.
FormElement::needsUtf8Safety(): Answers if the element needs to be treated with precautions according to possible utf-8 values.
FormElement::printCssClasses(): Compiles the html-class-attribute-string of the element.
FormElement::printDisabled(): Compiles the html-disabled-attribute-string of the element.
FormElement::printId(): Compiles the html-id-attribute-string of the element.
FormElement::printJavascriptEventHandler(): Compiles html-javascript-eventhandler-string of the element.
FormElement::printJavascriptValidationCode(): Grabs the compiled JS-validation-code for the element from its validator, if present and returns the code as a string.
FormElement::printMessages(): Returns a string of all aggregated error messages of the element.
FormElement::printName(): Compiles the html-name-string of the element.
FormElement::printNameArray(): Comiles the html-name-string of the element, if the element is part of a group of values.
FormElement::printTabIndex(): Calculates current ongoing tabindex of the form, refreshes it and returns the proper value for the element.
FormElement::printTitle(): Compiles the html-title-string of the element.
FormElement::printWrapperClasses(): Compiles a string of all classes for the tag-wrapper for the element's html-code.
FormElement::setCssClasses(): Sets the html-class-attribute for the element.
FormElement::setDisabled(): Set the element disabled.
FormElement::setId(): Sets the html-id for this element.
FormElement::setJavascriptEventHandler(): Sets a javascript-handler for the element.
FormElement::setLabel(): Inserts a label for the element.
FormElement::setMasterElement(): Sets the owning element for an element.
FormElement::setMasterForm(): Sets the owning form for an element and by doing so inserts the element into the logical structure of the form.
FormElement::setTitle(): Sets the html-title for this element.
FormElement::setUsable(): Set the element usables or disabled based on an expression.
FormElement::setValidator(): Sets a validator for a value-bearing element.
FormElement::validate(): Starts validation for the element and all subelements according to the rules laid out in the element's validator.

Class Details

[line 24]
Wraps a hidden input.

If you need to get some random data into the valueset of a form, this is, like in html, they way to go. This element, doesn't display, but only carries a value by the same means a text-input would, just without the editing possibilites.

Tags:

author:	Sebastian Schlapkohl
version:	1.0

[ Top ]

Class Methods

static method get [line 51]

static InputHidden get(
String
$name, [String
$id = ''])

Factory method for InputHidden, returns new instance.

Factories are used to make instant chaining possible.

Tags:

return:	new InputHidden-instance
access:	public

Parameters:

String	$name	html-name for the element
String	$id	html-id for the element

[ Top ]

constructor __construct [line 35]

InputHidden __construct(
String
$name, [String
$id = ''])

Hidden constructor.

Get new instances with "get()" instead.

Tags:

access:

protected

Overrides FormElement::__construct() (General abstract, hidden formelement constructor.)

Parameters:

String	$name	html-name for the element
String	$id	html-id for the element

[ Top ]

method doRender [line 146]

String doRender(
)

Compiles and returns the html-fragment for the element.

InputHidden has a very reduced rendering, with things like css-classes and everything visual ignored. If you need them for whatever reason, you're doing something wrong. This element is for form-value-injection only.

Tags:

return:	html-fragment for the element
access:	public

Overrides FormElement::doRender() (Returns the compiled html-code for the element.)

[ Top ]

method getValue [line 81]

String getValue(
)

Returns the currently set value of the element.

Tags:

return:	currently set value of the element
access:	public

Overrides FormElement::getValue() (Returns the value of the element if there is any.)

[ Top ]

method refill [line 98]

InputText refill(
[Array[String]|null
$refiller = array()], [Boolean
$condition = true])

Tries to refill the element-value from existing data.

This data can eiter be one of the method-arrays dependent on the method the surrounding form uses or a supplied array of name-value-pairs.

Tags:

return:	method owner
access:	public

Parameters:

Array[String]\|null	$refiller	data to use as the refill source
Boolean	$condition	expression which defines if the refill will take place or not, to make it conditional so to speak

[ Top ]

method setValue [line 67]

InputHidden setValue(
String
$val)

Directly sets the value for the element.

Tags:

return:	method owner
access:	public

Parameters:

String

$val

new value for the element

[ Top ]

method validate [line 123]

Boolean validate(
)

Starts the validation-process for the element.

Calculates the validity-status, based on the currently entered value, by applying the rules of a present validator. If there is none, the element is always valid.

Tags:

return:	element is currently valid yes/no
access:	public

Overrides FormElement::validate() (Starts validation for the element and all subelements according to the rules laid out in the element's validator.)

[ Top ]

Documentation generated on Fri, 18 Jul 2014 16:31:58 +0200 by phpDocumentor 1.4.3