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

Class: HTML_QuickForm_checkbox

Source Location: /main/inc/lib/pear/HTML/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):

Version:

  • 1.1

Variables

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
HTML_QuickForm_element::_findValue()
Tries to find the element value from the values array
HTML_QuickForm_element::_generateId()
Automatically generates and assigns an 'id' attribute for the element.
HTML_QuickForm_element::_getPersistantData()
Used by getFrozenHtml() to pass the element's value if _persistantFreeze is on
HTML_QuickForm_element::_prepareValue()
Used by exportValue() to prepare the value for returning

Class: HTML_Common

HTML_Common::HTML_Common()
Class constructor
HTML_Common::apiVersion()
Returns the current API version
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::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
HTML_Common::_getAttrKey()
Returns the array key for the given non-name-value pair attribute
HTML_Common::_getAttrString()
Returns an HTML formatted attribute string
HTML_Common::_getLineEnd()
Returns the lineEnd
HTML_Common::_getTab()
Returns a string containing the unit for indenting HTML
HTML_Common::_getTabs()
Returns a string containing the offset for the whole HTML code
HTML_Common::_parseAttributes()
Returns a valid atrributes array from either a string or array
HTML_Common::_removeAttr()
Removes the given attribute from the given array
HTML_Common::_updateAttrArray()
Updates the attributes in $attr1 with the values in $attr2 without changing the other existing attributes

Class Details

[line 33]
HTML class for a checkbox type field



Tags:

author:  Adam Daniel <adaniel1@eesus.jnj.com>
author:  Bertrand Mansion <bmansion@mamasam.com>
version:  1.1
since:  PHP4.04pl1
access:  public


[ Top ]


Class Variables

$_text =  ''

[line 43]

Checkbox display text



Tags:

since:  1.1
access:  private

Type:   string


[ Top ]



Class Methods


constructor HTML_QuickForm_checkbox [line 60]

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

Class constructor



Tags:

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 ]

method exportValue [line 257]

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 ]

method getChecked [line 100]

bool getChecked( )

Returns whether a checkbox is checked



Tags:

since:  1.0
access:  public


[ Top ]

method getFrozenHtml [line 137]

string getFrozenHtml( )

Returns the value of field without HTML tags



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 ]

method getText [line 173]

string getText( )

Returns the checkbox text



Tags:

since:  1.1
access:  public


[ Top ]

method getValue [line 204]

bool getValue( )

Returns the value of the form element



Tags:

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 ]

method onQuickFormEvent [line 222]

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


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
   &$caller  

[ Top ]

method setChecked [line 81]

void setChecked( bool $checked)

Sets whether a checkbox is checked



Tags:

since:  1.0
access:  public


Parameters:

bool   $checked   Whether the field is checked or not

[ Top ]

method setText [line 158]

void setText( string $text)

Sets the checkbox text



Tags:

since:  1.1
access:  public


Parameters:

string   $text  

[ Top ]

method setValue [line 189]

void setValue( string $value)

Sets the value of the form element



Tags:

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 ]

method toHtml [line 115]

string toHtml( )

Returns the checkbox element in HTML



Tags:

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 ]


Documentation generated on Thu, 12 Jun 2008 13:03:28 -0500 by phpDocumentor 1.4.1