Class: HTML_QuickForm_checkbox

Source Location: /HTML_QuickForm-3.2.14/QuickForm/checkbox.php

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_input
         |
         --HTML_QuickForm_checkbox

HTML class for a checkbox type field

Author(s):

Alexey Borzov <avb at php.net>
Adam Daniel <adaniel1 at eesus.jnj.com>
Bertrand Mansion <bmansion at mamasam.com>

Version:

Release: 3.2.14

Methods

Child classes:

HTML_QuickForm_advcheckbox: HTML class for an advanced checkbox type field

Inherited Variables

Inherited Methods

Class: HTML_QuickForm_input

HTML_QuickForm_input::HTML_QuickForm_input(): Class constructor
HTML_QuickForm_input::exportValue(): We don't need values from button-type elements (except submit) and files
HTML_QuickForm_input::getName(): Returns the element name
HTML_QuickForm_input::getValue(): Returns the value of the form element
HTML_QuickForm_input::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_input::setName(): Sets the input field name
HTML_QuickForm_input::setType(): Sets the element type
HTML_QuickForm_input::setValue(): Sets the value of the form element
HTML_QuickForm_input::toHtml(): Returns the input field in HTML

Class: HTML_QuickForm_element

HTML_QuickForm_element::HTML_QuickForm_element(): Class constructor
HTML_QuickForm_element::accept(): Accepts a renderer
HTML_QuickForm_element::apiVersion(): Returns the current API version
HTML_QuickForm_element::exportValue(): Returns a 'safe' element's value
HTML_QuickForm_element::freeze(): Freeze the element so that only its value is returned
HTML_QuickForm_element::getFrozenHtml(): Returns the value of field without HTML tags
HTML_QuickForm_element::getLabel(): Returns display text for the element
HTML_QuickForm_element::getName(): Returns the element name
HTML_QuickForm_element::getType(): Returns element type
HTML_QuickForm_element::getValue(): Returns the value of the form element
HTML_QuickForm_element::isFrozen(): Returns whether or not the element is frozen
HTML_QuickForm_element::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_element::setLabel(): Sets display text for the element
HTML_QuickForm_element::setName(): Sets the input field name
HTML_QuickForm_element::setPersistantFreeze(): Sets wether an element value should be kept in an hidden field when the element is frozen or not
HTML_QuickForm_element::setValue(): Sets the value of the form element
HTML_QuickForm_element::unfreeze(): Unfreezes the element so that it becomes editable

Class Details

[line 42]
HTML class for a checkbox type field

Author: Alexey Borzov <avb@php.net>
Author: Adam Daniel <adaniel1@eesus.jnj.com>
Author: Bertrand Mansion <bmansion@mamasam.com>
Version: Release: 3.2.14
Since: 1.0

[ Top ]

Method Detail

HTML_QuickForm_checkbox (Constructor) [line 69]

void HTML_QuickForm_checkbox(
[string
$elementName = null], [string
$elementLabel = null], [string
$text = ''], [mixed
$attributes = null])

Class constructor

Since: 1.0
Access: public

Parameters:

string	`$elementName`	—	(optional)Input field name attribute
string	`$elementLabel`	—	(optional)Input field value
string	`$text`	—	(optional)Checkbox display text
mixed	`$attributes`	—	(optional)Either a typical HTML attribute string or an associative array

[ Top ]

exportValue [line 266]

void exportValue(

&$submitValues, [
$assoc = false])

Return true if the checkbox is checked, null if it is not checked (getValue() returns false)

Overridden in child classes as:

HTML_QuickForm_advcheckbox::exportValue(): This element has a value even if it is not checked, thus we override

Overrides HTML_QuickForm_input::exportValue() (We don't need values from button-type elements (except submit) and files)

Parameters:

	`&$submitValues`	—
	`$assoc`	—

[ Top ]

getChecked [line 109]

bool getChecked(
)

Returns whether a checkbox is checked

Since: 1.0
Access: public

[ Top ]

getFrozenHtml [line 146]

string getFrozenHtml(
)

Returns the value of field without HTML tags

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_advcheckbox::getFrozenHtml(): Unlike checkbox, this has to append a hidden input in both

Overrides HTML_QuickForm_element::getFrozenHtml() (Returns the value of field without HTML tags)

[ Top ]

getText [line 182]

string getText(
)

Returns the checkbox text

Since: 1.1
Access: public

[ Top ]

getValue [line 213]

bool getValue(
)

Returns the value of the form element

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_advcheckbox::getValue(): Returns the element's value

Overrides HTML_QuickForm_input::getValue() (Returns the value of the form element)

[ Top ]

onQuickFormEvent [line 231]

void onQuickFormEvent(
string
$event, mixed
$arg, object
&$caller)

Called by HTML_QuickForm whenever form event is made on this element

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_advcheckbox::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element

Overrides HTML_QuickForm_input::onQuickFormEvent() (Called by HTML_QuickForm whenever form event is made on this element)

Parameters:

string	`$event`	—	Name of event
mixed	`$arg`	—	event arguments
object	`&$caller`	—	calling object

[ Top ]

setChecked [line 90]

void setChecked(
bool
$checked)

Sets whether a checkbox is checked

Since: 1.0
Access: public

Parameters:

bool $checked — Whether the field is checked or not

[ Top ]

setText [line 167]

void setText(
string
$text)

Sets the checkbox text

Since: 1.1
Access: public

Parameters:

string $text —

[ Top ]

setValue [line 198]

void setValue(
string
$value)

Sets the value of the form element

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_advcheckbox::setValue(): Sets the element's value

Overrides HTML_QuickForm_input::setValue() (Sets the value of the form element)

Parameters:

string $value — Default value of the form element

[ Top ]

toHtml [line 124]

string toHtml(
)

Returns the checkbox element in HTML

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_advcheckbox::toHtml(): Returns the checkbox element in HTML and the additional hidden element in HTML

Overrides HTML_QuickForm_input::toHtml() (Returns the input field in HTML)

[ Top ]