Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

ControlContainer Class Reference

Inheritance diagram for ControlContainer:

Inheritance graph
List of all members.

Detailed Description

A container for controls.

This class is designed to ease the management of a group of controls.

Definition at line 1669 of file controls.php.

Public Member Functions

 ControlContainer ()
& get ($id)
 Get a control.

& getByValue ($value)
 Get a control that has a certain value.

 add (&$control)
 Add a control.

 exists ($id)
 Check whether a control exists.

 count ()
 Get the number of controls in the container.

& remove ($id)
 Remove and return a control.

 getAllIds ()
 Get all control IDs.

 getAllControls ()
 Get all controls.

 getDisplayableIds ()
 Get the IDs of controls which can be displayed.

 getDisplayableControls ()
 Get the controls which can be displayed.

 childDisplay ($id)
 Check whether a contained control can be displayed.

 childToString ($id)
 Get a string representation of a contained control.

 childUpdated ($id)
 Check whether a contained control has been updated.

 triggerChildActions ()
 Trigger all actions of the contained controls.

 getTriggerOrder ()
 Get the order in which controls are to be triggered.

 setTriggerOrder ($order)
 Set the order in which controls are to be triggered.

 __sleep ()

Public Attributes

 $controls
 the list of controls

 $trigger_order
 The order in which controls will be triggered.

Constructor & Destructor Documentation

ControlContainer::ControlContainer (   ) 
 

Definition at line 1676 of file controls.php.

Member Function Documentation

ControlContainer::__sleep (   ) 
 

Reimplemented in ControlChoice.

Definition at line 1932 of file controls.php.

ControlContainer::add (  &$  control  ) 
 

Add a control.

Parameters:
$control a reference to the control
Returns:
void

Reimplemented in ControlChoice.

Definition at line 1724 of file controls.php.

ControlContainer::childDisplay (  $  id  ) 
 

Check whether a contained control can be displayed.

Parameters:
$id the ID of the control
Returns:
true if the control can be displayed, false otherwise

Definition at line 1850 of file controls.php.

ControlContainer::childToString (  $  id  ) 
 

Get a string representation of a contained control.

Parameters:
$id the ID of the control
Returns:
the serialised control

Definition at line 1861 of file controls.php.

ControlContainer::childUpdated (  $  id  ) 
 

Check whether a contained control has been updated.

Parameters:
$id the ID of the control
Returns:
the result of calling ControlElement::updated() on the child

Definition at line 1872 of file controls.php.

ControlContainer::count (   ) 
 

Get the number of controls in the container.

Returns:
an integer specifying the number of controls

Definition at line 1752 of file controls.php.

ControlContainer::exists (  $  id  ) 
 

Check whether a control exists.

Parameters:
$id the id of the control
Returns:
true if the control exists, false otherwise

Definition at line 1743 of file controls.php.

& ControlContainer::get (  $  id  ) 
 

Get a control.

Parameters:
$id the id of the control
Returns:
a reference to the control

Definition at line 1691 of file controls.php.

ControlContainer::getAllControls (   ) 
 

Get all controls.

Returns:
an array of references to the controls

Definition at line 1798 of file controls.php.

References $controls.

ControlContainer::getAllIds (   ) 
 

Get all control IDs.

Returns:
a list of control IDs

Definition at line 1789 of file controls.php.

& ControlContainer::getByValue (  $  value  ) 
 

Get a control that has a certain value.

If a control has the specified value, it is returned. Only the first such matching control is returned.

Parameters:
$value the value to be checked
Returns:
a reference to the control, or null if no control has a matching value

Definition at line 1705 of file controls.php.

ControlContainer::getDisplayableControls (   ) 
 

Get the controls which can be displayed.

Returns:
an array of references to controls

Definition at line 1831 of file controls.php.

ControlContainer::getDisplayableIds (   ) 
 

Get the IDs of controls which can be displayed.

Returns:
an array of IDs

Definition at line 1814 of file controls.php.

ControlContainer::getTriggerOrder (   ) 
 

Get the order in which controls are to be triggered.

Returns:
an array of control IDs

Definition at line 1897 of file controls.php.

& ControlContainer::remove (  $  id  ) 
 

Remove and return a control.

Parameters:
$id the id of the control to remove
Returns:
a reference to the control or false if it does not exist

Definition at line 1762 of file controls.php.

ControlContainer::setTriggerOrder (  $  order  ) 
 

Set the order in which controls are to be triggered.

Parameters:
$order an array of control IDs
Returns:
void

Definition at line 1907 of file controls.php.

ControlContainer::triggerChildActions (   ) 
 

Trigger all actions of the contained controls.

Returns:
void

Definition at line 1884 of file controls.php.

Member Data Documentation

ControlContainer::$controls
 

the list of controls

Definition at line 1672 of file controls.php.

Referenced by getAllControls().

ControlContainer::$trigger_order
 

The order in which controls will be triggered.

Definition at line 1674 of file controls.php.

The documentation for this class was generated from the following file:
Generated on Mon Feb 14 11:39:51 2005 for FormControls by doxygen 1.3.5