Class: HTML_QuickForm_hierselect

Source Location: /HTML_QuickForm-3.2.5/QuickForm/hierselect.php

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_group
         |
         --HTML_QuickForm_hierselect

Class to dynamically create two or more HTML Select elements The first select changes the content of the second select and so on.

Author(s):

Herim Vasquez <vasquezh at iro.umontreal.ca>
Bertrand Mansion <bmansion at mamasam.com>

Version:

Methods

Inherited Variables

Inherited Methods

Class: HTML_QuickForm_group

HTML_QuickForm_group::HTML_QuickForm_group(): Class constructor
HTML_QuickForm_group::accept(): Accepts a renderer
HTML_QuickForm_group::exportValue(): As usual, to get the group's value we access its elements and call
HTML_QuickForm_group::freeze()
HTML_QuickForm_group::getElementName(): Returns the element name inside the group such as found in the html form
HTML_QuickForm_group::getElements(): Gets the grouped elements
HTML_QuickForm_group::getFrozenHtml(): Returns the value of field without HTML tags
HTML_QuickForm_group::getGroupType(): Gets the group type based on its elements Will return 'mixed' if elements contained in the group are of different types.
HTML_QuickForm_group::getName(): Returns the group name
HTML_QuickForm_group::getValue(): Returns the value of the group
HTML_QuickForm_group::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_group::setElements(): Sets the grouped elements
HTML_QuickForm_group::setName(): Sets the group name
HTML_QuickForm_group::setPersistantFreeze()
HTML_QuickForm_group::setValue(): Sets values for group's elements
HTML_QuickForm_group::toHtml(): Returns Html for the group
HTML_QuickForm_group::unfreeze()

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 38]
Class to dynamically create two or more HTML Select elements The first select changes the content of the second select and so on.

This element is considered as a group. Selects will be named groupName[0], groupName[1], groupName[2]...

Author: Herim Vasquez <vasquezh@iro.umontreal.ca>
Author: Bertrand Mansion <bmansion@mamasam.com>
Version: 1.0
Since: PHP4.04pl1
Access: public

[ Top ]

Method Detail

HTML_QuickForm_hierselect (Constructor) [line 117]

void HTML_QuickForm_hierselect(
[string
$elementName = null], [string
$elementLabel = null], [mixed
$attributes = null], [mixed
$separator = null])

Class constructor

Access: public

Parameters:

string	`$elementName`	—	(optional)Input field name attribute
string	`$elementLabel`	—	(optional)Input field label in form
mixed	`$attributes`	—	(optional)Either a typical HTML attribute string or an associative array. Date format is passed along the attributes.
mixed	`$separator`	—	(optional)Use a string for one separator, use an array to alternate the separators.

[ Top ]

accept [line 451]

void accept(

&$renderer, [
$required = false], [
$error = null])

Overrides HTML_QuickForm_group::accept() (Accepts a renderer)

Parameters:

	`&$renderer`	—
	`$required`	—
	`$error`	—

[ Top ]

onQuickFormEvent [line 459]

void onQuickFormEvent(

$event, 
$arg, 
&$caller)

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

Parameters:

	`$event`	—
	`$arg`	—
	`&$caller`	—

[ Top ]

setMainOptions [line 171]

void setMainOptions(
array
$array)

Sets the options for the first select element. Deprecated. setOptions() should be used.

Access: public

Parameters:

array $array — Options for the first select element

[ Top ]

setOptions [line 140]

void setOptions(
array
$options)

Initialize the array structure containing the options for each select element.

Call the functions that actually do the magic.

Access: public

Parameters:

array $options — Array of options defining each element

[ Top ]

setSecOptions [line 193]

void setSecOptions(
array
$array)

Sets the options for the second select element. Deprecated. setOptions() should be used.

The main _options array is initialized and the _setOptions function is called.

Access: public

Parameters:

array $array — Options for the second select element

[ Top ]

setValue [line 250]

void setValue(
array
$value)

Sets values for group's elements

Access: public

Overrides HTML_QuickForm_group::setValue() (Sets values for group's elements)

Parameters:

array $value — An array of 2 or more values, for the first, the second, the third etc. select

[ Top ]

toHtml [line 276]

void toHtml(
)

Overrides HTML_QuickForm_group::toHtml() (Returns Html for the group)

[ Top ]