Class: Label

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 27]
Wraps a label for the use in the direct vicinity of a formelement.

Each value-widget can have a label, to describe it's purpose, this class gathers the necessary information, and compile the label with correct linkage and wrapping.

If you want a logical connection between a label and an element, make sure the element has an id, since that's what defines the connection here.

This element should not be inserted manually into a form, but rather be seen as a subwidget automatically provided the a value-bearing-element. If you implement one yourself, be sure to also use Label.

Tags:

author:	Sebastian Schlapkohl
version:	1.0

[ Top ]

Class Methods

static method get [line 61]

static Label get(
FormElement
$inputToLabel)

Factory method for Label, returns new instance.

Factories are used to make instant chaining possible.

Tags:

return:	new Label-instance
access:	public

Parameters:

FormElement

$inputToLabel

the element to attach the label to

[ Top ]

static method getInline [line 75]

static Label getInline(
String
$caption, String
$for)

Special factory-method for labels to be displayed inline, and not in a own wrapping element.

Tags:

return:	new inline-label
access:	public

Parameters:

String	$caption	the text the label should show
String	$for	the id of the element the label should be associated to

[ Top ]

constructor __construct [line 46]

Label __construct(
FormElement
$inputToLabel)

Hidden constructor.

Get new instances with "get()" instead.

Tags:

access:

protected

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

Parameters:

FormElement

$inputToLabel

the element to attach the label to

[ Top ]

method doRender [line 120]

String doRender(
)

Compiles and returns the html-fragment for the element.

Wrapped in normal mode, barebone if set to inline.

Tags:

return:	html-fragment for the element
access:	public

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

[ Top ]

method getValue [line 106]

null getValue(
)

Since Label doesn't hold any value, this method will always return null.

Tags:

access:

public

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

[ Top ]

method setInline [line 92]

Label setInline(
)

Sets the element to inline-mode, where no wrapping container is rendered, but only the pure label-tag.

Tags:

return:	method owner
access:	public

[ Top ]

Class Constants

WRAPCLASS = 'htmlform_label_div'

[line 33]

css-class for the label wrapper

[ Top ]

Documentation generated on Fri, 18 Jul 2014 16:32:00 +0200 by phpDocumentor 1.4.3