cHTMLFormElement class represents a form element.
| package | Core |
|---|---|
| subpackage | Frontend |
__construct(string $name, string $id, string $disabled, string $tabindex, string $accesskey, string $class) : void
This is a generic form element, where specific elements should be inherited from this class.
stringName of the element
stringID of the element
stringItem disabled flag (non-empty to set disabled)
stringTab index for form elements
stringKey to access the field
stringCSS class name to set
__toString() : string
| inherited_from | \cHTML::__toString() |
|---|
stringGenerated markupaddRequiredScript(string $script) : \cHTML
Anyway, scripts are not included twice.
| inherited_from | \cHTML::addRequiredScript() |
|---|
stringthe script to include
\cHTML$thisadvanceID() : \cHTML
This function is useful if you need to use HTML elements in a loop, but don't want to re-create new objects each time.
| inherited_from | \cHTML::advanceID() |
|---|
\cHTML$thisappendStyleDefinition(string $property, string $value) : \cHTML
Example usage: $element->appendStyleDefinition('margin', '5px');
| inherited_from | \cHTML::appendStyleDefinition() |
|---|
stringthe property name, e.g. 'margin'
stringthe value of the property, e.g. '5px'
\cHTML$thisappendStyleDefinitions(array $styles) : \cHTML
Example usage: $element->appendStyleDefinitions(array( 'margin' => '5px', 'padding' => '0' ));
| inherited_from | \cHTML::appendStyleDefinitions() |
|---|
stringthe styles to append
\cHTML$thisattachEventDefinition(string $name, string $event, string $code) : \cHTML
Example to attach an onClick handler: attachEventDefinition('foo', 'onClick', 'alert("foo");');
| inherited_from | \cHTML::attachEventDefinition() |
|---|
stringDefines the name of the event
stringDefines the event (e.g. onClick)
stringDefines the code
\cHTML$thisattachStyleDefinition(string $name, string $definition) : \cHTML
This function is not restricted to a single style, e.g. you can set multiple style definitions as-is to the handler.
$example->attachStyle('myIdentifier', 'border: 1px solid black; white-space: nowrap'); $example->attachStyle('myIdentifier2', 'padding: 0px');
Results in:
style="border: 1px solid black; white-space: nowrap; padding: 0px;"
| inherited_from | \cHTML::attachStyleDefinition() |
|---|
stringName for a style definition
stringDefinition for the given entity
\cHTML$thiscHTML()
| inherited_from | \cHTML::cHTML() |
|---|
cHTMLFormElement($name, $id, $disabled, $tabindex, $accesskey, $class)
| deprecated | [2012-01-19] use __construct instead |
|---|
display()
| inherited_from | \cHTML::display() |
|---|
fillCloseSkeleton() : string
| inherited_from | \cHTML::fillCloseSkeleton() |
|---|
stringfilled SGML closer skeletonfillSkeleton(string $attributes) : string
fillSkeleton fills the SGML opener tag with the specified attributes. Attributes need to be passed in the stringyfied variant.
| inherited_from | \cHTML::fillSkeleton() |
|---|
stringAttributes to set
stringfilled SGML opener skeletongetAttribute(string $attributeName) : string
| inherited_from | \cHTML::getAttribute() |
|---|
stringAttribute name
stringnull value or null if the attribute does not
existgetAttributes(bool $returnAsString) : array
| inherited_from | \cHTML::getAttributes() |
|---|
boolWhether to return the attributes as string
arraystringgetID() : string
| inherited_from | \cHTML::getID() |
|---|
stringcurrent IDremoveAttribute(string $attributeName) : \cHTML
| inherited_from | \cHTML::removeAttribute() |
|---|
stringAttribute name
\cHTML$thisrender() : string
| inherited_from | \cHTML::render() |
|---|
stringGenerated markupsetAccessKey(string $accesskey) : \cHTMLFormElement
stringThe length of the access key. May be A-Z and 0-9.
\cHTMLFormElement$thissetAlt(string $alt) : \cHTML
Sets the "alt" and "title" tags. Usually, "alt" is used for accessibility and "title" for mouse overs.
To set the text for all browsers for mouse over, set "alt" and "title". IE behaves incorrectly and shows "alt" on mouse over. Mozilla browsers only show "title" as mouse over.
| inherited_from | \cHTML::setAlt() |
|---|
stringText to set as the "alt" and "title" attribute
\cHTML$thissetAttribute(string $attributeName, string $value) : \cHTML
| inherited_from | \cHTML::setAttribute() |
|---|
stringName of the attribute
stringValue of the attribute
\cHTML$thissetAttributes(array $attributes) : \cHTML
| inherited_from | \cHTML::setAttributes() |
|---|
arrayAssociative array with attributes
\cHTML$thissetClass(string $class) : \cHTML
| inherited_from | \cHTML::setClass() |
|---|
stringText to set as the "class" attribute
\cHTML$thissetDisabled(string $disabled) : \cHTMLFormElement
User Agents usually are showing the element as "greyed-out".
Example: $obj->setDisabled('disabled'); $obj->setDisabled('');
The first example sets the disabled flag, the second one removes the disabled flag.
stringSets the disabled-flag if non-empty
\cHTMLFormElement$thissetEvent(string $event, string $action) : \cHTML
example: $item->setEvent('change','document.forms[0].submit');
| inherited_from | \cHTML::setEvent() |
|---|
stringType of the event, e. g. "change" for "onchange"
stringFunction or action to call (JavaScript Code)
\cHTML$thissetGenerateXHTML(bool $value)
| inherited_from | \cHTML::setGenerateXHTML() |
|---|
bool
setStyle(string $style) : \cHTML
| inherited_from | \cHTML::setStyle() |
|---|
stringText to set as the "style" attribute
\cHTML$thissetStyleDefinition(string $entity, string $definition) : \cHTML
| inherited_from | \cHTML::setStyleDefinition() |
|---|
stringEntity to define
stringDefinition for the given entity
\cHTML$thissetTabindex(int $tabindex) : \cHTMLFormElement
The tab index needs to be numeric, bigger than 0 and smaller than 32767.
intDesired tab index
\cHTMLFormElement$thistoHTML() : string
| inherited_from | \cHTML::toHTML() |
|---|
stringGenerated markupunsetEvent(string $event) : \cHTML
example: $item->unsetEvent('change');
| inherited_from | \cHTML::unsetEvent() |
|---|
stringType of the event
\cHTML$thisupdateAttribute(string $name, string $value) : \cHTML
| inherited_from | \cHTML::updateAttribute() |
|---|
stringthe name of the attribute
stringthe value of the attribute with the given name
\cHTML$thisupdateAttributes(array $attributes) : \cHTML
| inherited_from | \cHTML::updateAttributes() |
|---|
arrayAssociative array with attributes
\cHTML$this_appendContent(string | object | array $content) : \cHTML
| inherited_from | \cHTML::_appendContent() |
|---|
stringobjectarrayString with the content or an object to render or an array of strings/objects.
\cHTML$this_getAttrString(array $attributes) : string
| inherited_from | \cHTML::_getAttrString() |
|---|
arrayAssociative array with attributes
stringAttribute string in HTML format_parseAttributes(array $attributes) : array
| inherited_from | \cHTML::_parseAttributes() |
|---|
arrayAssociative array with attributes
arraythe parsed attributes_setContent(string | object | array $content) : \cHTML
| inherited_from | \cHTML::_setContent() |
|---|
stringobjectarrayString with the content or a cHTML object to render or an array of strings / objects.
\cHTML$this$_attributes : array
| inherited_from | \cHTML::$$_attributes |
|---|
$_content : string
| inherited_from | \cHTML::$$_content |
|---|
$_contentlessTag : bool
| inherited_from | \cHTML::$$_contentlessTag |
|---|
$_eventDefinitions : array
| inherited_from | \cHTML::$$_eventDefinitions |
|---|
$_generateXHTML : bool
| inherited_from | \cHTML::$$_generateXHTML |
|---|
$_idCounter : int
| inherited_from | \cHTML::$$_idCounter |
|---|
$_requiredScripts : array
| inherited_from | \cHTML::$$_requiredScripts |
|---|
$_skeletonClose : string
| inherited_from | \cHTML::$$_skeletonClose |
|---|
$_skeletonOpen : string
| inherited_from | \cHTML::$$_skeletonOpen |
|---|
$_skeletonSingle : string
| inherited_from | \cHTML::$$_skeletonSingle |
|---|
$_styleDefinitions : array
| inherited_from | \cHTML::$$_styleDefinitions |
|---|
$_styleDefs : array
| inherited_from | \cHTML::$$_styleDefs |
|---|
$_tag : string
| inherited_from | \cHTML::$$_tag |
|---|