HTML_QuickForm
[ class tree: HTML_QuickForm ] [ index: HTML_QuickForm ] [ all elements ]

Class: HTML_QuickForm_advcheckbox

Source Location: /HTML_QuickForm-3.2.14/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):

Version:

  • Release: 3.2.14

Methods


Inherited Variables

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 Details

[line 52]
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.



[ Top ]


Method Detail

HTML_QuickForm_advcheckbox (Constructor)   [line 89]

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

Class constructor
  • 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 ]

exportValue   [line 274]

void exportValue( &$submitValues, [ $assoc = false])

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 ]

getFrozenHtml   [line 225]

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 ]

getOnclickJs   [line 127]

string getOnclickJs( string $elementName)

Create the javascript for the onclick event which will set the value of the hidden field
  • Deprecated: Deprecated since 3.2.6, this element no longer uses any javascript
  • Access: public

Parameters:

string   $elementName     The element name

[ Top ]

getPrivateName   [line 108]

string getPrivateName( string $elementName)

Gets the private name for the element
  • 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 ]

getValue   [line 185]

mixed getValue( )

Returns the element's value
  • Access: public

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

onQuickFormEvent   [line 244]

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

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

[ Top ]

setValue   [line 170]

void setValue( mixed $value)

Sets the element's value
  • Access: public

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

Parameters:

mixed   $value     Element's value

[ Top ]

setValues   [line 145]

void setValues( mixed $values)

Sets the values used by the hidden element
  • Access: public

Parameters:

mixed   $values     The values, either a string or an array

[ Top ]

toHtml   [line 204]

string toHtml( )

Returns the checkbox element in HTML and the additional hidden element in HTML
  • Access: public

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


Documentation generated on Thu, 20 Nov 2014 16:00:06 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.