Abstract class representing one optigroup for conditional branching. More...

Inheritance diagram for base_optigroup:

Public Member Functions
	__construct ($name, $elements=null, $multiple=false)
	Constructor - instantiates one base_optigroup, specifying its basic info. More...

	add_attributes ($attributes)
	Adding attributes is forbidden.

	add_child ($element)

	add_final_elements ($attributes)
	Adding final elements is forbidden.

	add_optigroup ($optigroup)

	clean_value ()

	clean_values ()

	destroy ()
	Destroy all circular references. More...

	get_attribute ($name)

	get_attributes ()
	Public API starts here.

	get_child ($name)

	get_children ()

	get_final_element ($name)

	get_final_elements ()
	Public API starts here.

	get_level ()
	Return the level of this element, that will be, the level of the parent (doesn't consume level) (note this os only a "cosmetic" effect (to_string) as fact as the real responsible for this is the corresponding structure_processor for the final output.

	get_name ()
	Public API starts here.

	get_optigroup ()

	get_parent ()

	get_value ()

	is_set ()

	set_value ($value)

	to_string ($showvalue=false)

Protected Member Functions
	add_children ($elements)

	add_used ($element)
	Recalculate all the used elements in the optigroup, observing restrictions and passing the new used to outer level.

	check_and_set_used ($element)

	find_element_by_path ($path)

	find_first_parent_by_name ($name)

	get_grandoptigroupelement_or_grandparent ()

	get_grandparent ()

	get_new_attribute ($name)
	Instantiating attributes is forbidden.

	get_new_final_element ($name)
	Instantiating final elements is forbidden.

	get_used ()

	is_multiple ()

	set_parent ($element)
	Set the parent of the optigroup and, at the same time, process all the condition params in all the childs.

	set_used ($used)

	validate_name ($name)

Detailed Description

Abstract class representing one optigroup for conditional branching.

Constructor & Destructor Documentation

Constructor - instantiates one base_optigroup, specifying its basic info.

Parameters

string	$name	name of the element
array	$elements	base_optigroup_elements of this group
bool	$multiple	to decide if the group allows multiple branches processing or no

Reimplemented from base_nested_element.

base_nested_element::destroy ( )

inherited

Destroy all circular references.

It helps PHP 5.2 a lot!

Reimplemented from base_final_element.

The documentation for this class was generated from the following file: