Class: HTML_QuickForm2_Element_InputCheckable

Source Location: /HTML_QuickForm2-2.1.0/HTML/QuickForm2/Element/InputCheckable.php

Class Overview

HTML_Common2
   |
   --HTML_QuickForm2_Node
      |
      --HTML_QuickForm2_Element
         |
         --HTML_QuickForm2_Element_Input
            |
            --HTML_QuickForm2_Element_InputCheckable

Base class for <input> elements having 'checked' attribute (checkboxes and radios)

Author(s):

Bertrand Mansion <golgote at mamasam.com>
Alexey Borzov <avb at php.net>

Version:

Release: 2.1.0

Variables

Methods

Child classes:

HTML_QuickForm2_Element_InputRadio: Class for <input type="radio" /> elements

HTML_QuickForm2_Element_InputCheckbox: Class for <input type="checkbox" /> elements

Inherited Variables

Class: HTML_QuickForm2_Element_Input

HTML_QuickForm2_Element_Input::$watchedAttributes

Class: HTML_QuickForm2_Node

HTML_QuickForm2_Node::$container
HTML_QuickForm2_Node::$error
HTML_QuickForm2_Node::$filters
HTML_QuickForm2_Node::$frozen
HTML_QuickForm2_Node::$ids
HTML_QuickForm2_Node::$recursiveFilters
HTML_QuickForm2_Node::$rules

Inherited Methods

Class: HTML_QuickForm2_Element_Input

HTML_QuickForm2_Element_Input::getFrozenHtml(): Returns the field's value without HTML tags
HTML_QuickForm2_Element_Input::getRawValue()
HTML_QuickForm2_Element_Input::getType()
HTML_QuickForm2_Element_Input::onAttributeChange()
HTML_QuickForm2_Element_Input::setValue()
HTML_QuickForm2_Element_Input::__toString()

Class: HTML_QuickForm2_Element

HTML_QuickForm2_Element::applyFilters(): Applies recursive and non-recursive filters on element value
HTML_QuickForm2_Element::getJavascriptTriggers()
HTML_QuickForm2_Element::getJavascriptValue(): Returns Javascript code for getting the element's value
HTML_QuickForm2_Element::getPersistentContent(): Generates hidden form field containing the element's value
HTML_QuickForm2_Element::render(): Renders the element using the given renderer
HTML_QuickForm2_Element::setName()
HTML_QuickForm2_Element::updateValue(): Called when the element needs to update its value from form's data sources

Class: HTML_QuickForm2_Node

HTML_QuickForm2_Node::__construct(): Class constructor
HTML_QuickForm2_Node::addFilter(): Adds a filter
HTML_QuickForm2_Node::addRecursiveFilter(): Adds a recursive filter
HTML_QuickForm2_Node::addRule(): Adds a validation rule
HTML_QuickForm2_Node::applyFilter(): Helper function for applying filter callback to a value
HTML_QuickForm2_Node::applyFilters(): Applies non-recursive filters on element value
HTML_QuickForm2_Node::createRule(): Creates a validation rule
HTML_QuickForm2_Node::generateId(): Generates an id for the element
HTML_QuickForm2_Node::getContainer(): Returns the element containing current
HTML_QuickForm2_Node::getData(): Returns the element options
HTML_QuickForm2_Node::getDataSources(): Returns the data sources for this element
HTML_QuickForm2_Node::getError(): Returns the error message for the element
HTML_QuickForm2_Node::getId(): Returns the element's id
HTML_QuickForm2_Node::getJavascriptTriggers(): Returns IDs of form fields that should trigger "live" Javascript validation
HTML_QuickForm2_Node::getJavascriptValue(): Returns Javascript code for getting the element's value
HTML_QuickForm2_Node::getLabel(): Returns the element's label(s)
HTML_QuickForm2_Node::getName(): Returns the element's name
HTML_QuickForm2_Node::getRawValue(): Returns the element's value without filters applied
HTML_QuickForm2_Node::getType(): Returns the element's type
HTML_QuickForm2_Node::getValue(): Returns the element's value, possibly with filters applied
HTML_QuickForm2_Node::isRequired(): Checks whether an element is required
HTML_QuickForm2_Node::onAttributeChange(): Intercepts setting 'name' and 'id' attributes
HTML_QuickForm2_Node::persistentFreeze(): Changes the element's persistent freeze behaviour
HTML_QuickForm2_Node::removeRule(): Removes a validation rule
HTML_QuickForm2_Node::render(): Renders the element using the given renderer
HTML_QuickForm2_Node::renderClientRules(): Adds element's client-side validation rules to a builder object
HTML_QuickForm2_Node::setContainer(): Adds the link to the element containing current
HTML_QuickForm2_Node::setError(): Sets the error message to the element
HTML_QuickForm2_Node::setId(): Sets the element's id
HTML_QuickForm2_Node::setLabel(): Sets the element's label(s)
HTML_QuickForm2_Node::setName(): Sets the element's name
HTML_QuickForm2_Node::setValue(): Sets the element's value
HTML_QuickForm2_Node::storeId(): Stores the explicitly given id to prevent duplicate id generation
HTML_QuickForm2_Node::toggleFrozen(): Changes the element's frozen status
HTML_QuickForm2_Node::updateValue(): Called when the element needs to update its value from form's data sources
HTML_QuickForm2_Node::validate(): Performs the server-side validation

Class Details

[line 38]
Base class for <input> elements having 'checked' attribute (checkboxes and radios)

Author: Bertrand Mansion <golgote@mamasam.com>
Author: Alexey Borzov <avb@php.net>
Version: Release: 2.1.0
Link: https://pear.php.net/package/HTML_QuickForm2
License: BSD 3-Clause License

[ Top ]

Class Variables

$data = array('content' => '')

[line 59]

Contains options and data used for the element creation

content: Label "glued" to a checkbox or radio

Access: protected

Type:	array
Overrides:	Array

[ Top ]

$frozenHtml = array(
        'checked'   => 'On',
        'unchecked' => 'Off'
    )

[line 49]

HTML to represent the element in "frozen" state

Array index "checked" contains HTML for element's "checked" state, "unchecked" for not checked

Access: protected

Type:

array

[ Top ]

$persistent = true

[line 40]

Access: protected

Type:	mixed
Overrides:	Array

[ Top ]

Method Detail

__construct (Constructor) [line 61]

HTML_QuickForm2_Element_InputCheckable __construct(
[
$name = null], [
$attributes = null], [array
$data = array()])

Access: public

Overridden in child classes as:

HTML_QuickForm2_Element_InputCheckbox::__construct()

Overrides HTML_QuickForm2_Node::__construct() (Class constructor)

Parameters:

	`$name`	—
	`$attributes`	—
array	`$data`	—

[ Top ]

getContent [line 104]

string getContent(
)

Returns the label that will be "glued" to element's HTML

Access: public

[ Top ]

getFrozenHtml [line 142]

void getFrozenHtml(
)

Access: public

Overrides HTML_QuickForm2_Element_Input::getFrozenHtml() (Returns the field's value without HTML tags)

[ Top ]

getRawValue [line 119]

void getRawValue(
)

Access: public

Overrides HTML_QuickForm2_Element_Input::getRawValue() (parent method not documented)

[ Top ]

onAttributeChange [line 69]

void onAttributeChange(

$name, [
$value = null])

Access: protected

Overrides HTML_QuickForm2_Element_Input::onAttributeChange() (parent method not documented)

Parameters:

	`$name`	—
	`$value`	—

[ Top ]

setContent [line 93]

$this setContent(
string
$content)

Sets the label to be rendered glued to the element

This label is returned by __toString() method with the element's HTML. It is automatically wrapped into the <label> tag.

Access: public

Parameters:

string $content —

[ Top ]

setValue [line 110]

void setValue(

$value)

Access: public

Overrides HTML_QuickForm2_Element_Input::setValue() (parent method not documented)

Parameters:

$value —

[ Top ]

__toString [line 128]

void __toString(
)

Access: public

Overrides HTML_QuickForm2_Element_Input::__toString() (parent method not documented)

[ Top ]

Class: HTML_QuickForm2_Element_InputCheckable

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Class: HTML_QuickForm2_Element_Input

Class: HTML_QuickForm2_Node

Inherited Methods

Class: HTML_QuickForm2_Element_Input

Class: HTML_QuickForm2_Element

Class: HTML_QuickForm2_Node

Class Details

Class Variables

$data = array('content' => '')

$frozenHtml = array( 'checked' => 'On', 'unchecked' => 'Off' )

$persistent = true

Method Detail

__construct (Constructor) [line 61]

Parameters:

getContent [line 104]

getFrozenHtml [line 142]

getRawValue [line 119]

onAttributeChange [line 69]

Parameters:

setContent [line 93]

Parameters:

setValue [line 110]

Parameters:

__toString [line 128]

$frozenHtml = array(
'checked' => 'On',
'unchecked' => 'Off'
)