Class: HTML_QuickForm_advcheckbox

Source Location: /pear/HTML/QuickForm/advcheckbox.php

Class Overview

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

HTML class for an advanced checkbox type field

Author(s):

Jason Rust <jrust@php.net>

Version:

Inherited Methods

Class: HTML_QuickForm_checkbox

HTML_QuickForm_checkbox::HTML_QuickForm_checkbox(): Class constructor
HTML_QuickForm_checkbox::exportValue(): Return true if the checkbox is checked, null if it is not checked (getValue() returns false)
HTML_QuickForm_checkbox::getChecked(): Returns whether a checkbox is checked
HTML_QuickForm_checkbox::getFrozenHtml(): Returns the value of field without HTML tags
HTML_QuickForm_checkbox::getText(): Returns the checkbox text
HTML_QuickForm_checkbox::getValue(): Returns the value of the form element
HTML_QuickForm_checkbox::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_checkbox::setChecked(): Sets whether a checkbox is checked
HTML_QuickForm_checkbox::setText(): Sets the checkbox text
HTML_QuickForm_checkbox::setValue(): Sets the value of the form element
HTML_QuickForm_checkbox::toHtml(): Returns the checkbox element in HTML

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: HTML_Common

HTML_Common::HTML_Common(): Class constructor
HTML_Common::apiVersion(): Returns the current API version
HTML_Common::charset(): Sets the charset to use by htmlspecialchars() function
HTML_Common::display(): Displays the HTML to the screen
HTML_Common::getAttribute(): Returns the value of the given attribute
HTML_Common::getAttributes(): Returns the assoc array (default) or string of attributes
HTML_Common::getComment(): Returns the HTML comment
HTML_Common::getTabOffset(): Returns the tabOffset
HTML_Common::removeAttribute(): Removes an attribute
HTML_Common::setAttribute(): Sets the value of the attribute
HTML_Common::setAttributes(): Sets the HTML attributes
HTML_Common::setComment(): Sets the HTML comment to be displayed at the beginning of the HTML string
HTML_Common::setLineEnd(): Sets the line end style to Windows, Mac, Unix or a custom string.
HTML_Common::setTab(): Sets the string used to indent HTML
HTML_Common::setTabOffset(): Sets the tab offset
HTML_Common::toHtml(): Abstract method. Must be extended to return the objects HTML
HTML_Common::updateAttributes(): Updates the passed attributes without changing the other existing attributes

Class Details

[line 43]
HTML class for an advanced checkbox type field

Basically this fixes a problem that HTML has had where checkboxes can only pass a single value (the value of the checkbox when checked). A value for when the checkbox is not checked cannot be passed, and furthermore the checkbox variable doesn't even exist if the checkbox was submitted unchecked.

It works by prepending a hidden field with the same name and another "unchecked" value to the checbox. If the checkbox is checked, PHP overwrites the value of the hidden field with its value.

Tags:

author:	Jason Rust <jrust@php.net>
version:	1.1
since:	2.0
access:	public

[ Top ]

Class Methods

constructor HTML_QuickForm_advcheckbox [line 80]

void HTML_QuickForm_advcheckbox(
[string
$elementName = null], [string
$elementLabel = null], [string
$text = null], [mixed
$attributes = null], [mixed
$values = null])

Class constructor

Tags:

since:	1.0
access:	public

Parameters:

string	$elementName	(optional)Input field name attribute
string	$elementLabel	(optional)Input field label
string	$text	(optional)Text to put after the checkbox
mixed	$attributes	(optional)Either a typical HTML attribute string or an associative array
mixed	$values	(optional)Values to pass if checked or not checked

[ Top ]

method exportValue [line 265]

void exportValue(

&$submitValues, 
$assoc)

This element has a value even if it is not checked, thus we override

checkbox's behaviour here

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

Parameters:

	&$submitValues
	$assoc

[ Top ]

method getFrozenHtml [line 216]

void getFrozenHtml(
)

Unlike checkbox, this has to append a hidden input in both

checked and non-checked states

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

[ Top ]

method getOnclickJs [line 118]

string getOnclickJs(
string
$elementName)

Create the javascript for the onclick event which will set the value of the hidden field

Tags:

deprecated:	Deprecated since 3.2.6, this element no longer uses any javascript
access:	public

Parameters:

string

$elementName

The element name

[ Top ]

method getPrivateName [line 99]

string getPrivateName(
string
$elementName)

Gets the private name for the element

Tags:

deprecated:	Deprecated since 3.2.6, both generated elements have the same name
access:	public

Parameters:

string

$elementName

The element name to make private

[ Top ]

method getValue [line 176]

mixed getValue(
)

Returns the element's value

Tags:

access:

public

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

[ Top ]

method onQuickFormEvent [line 235]

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

Called by HTML_QuickForm whenever form event is made on this element

Tags:

since:	1.0
access:	public

Overrides HTML_QuickForm_checkbox::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
	&$caller

[ Top ]

method setValue [line 161]

void setValue(
mixed
$value)

Sets the element's value

Tags:

access:

public

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

Parameters:

mixed

$value

Element's value

[ Top ]

method setValues [line 136]

void setValues(
mixed
$values)

Sets the values used by the hidden element

Tags:

access:

public

Parameters:

mixed

$values

The values, either a string or an array

[ Top ]

method toHtml [line 195]

string toHtml(
)

Returns the checkbox element in HTML and the additional hidden element in HTML

Tags:

access:

public

Overrides HTML_QuickForm_checkbox::toHtml() (Returns the checkbox element in HTML)

[ Top ]

Documentation generated on Sun, 08 Jan 2012 17:51:40 +0100 by phpDocumentor 1.4.3