Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
base_optigroup Class Reference

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

Inheritance diagram for base_optigroup:
base_nested_element base_final_element base_atom backup_optigroup

Public Member Functions

 __construct ($name, $elements=null, $multiple=false)
 Constructor - instantiates one base_optigroup, specifying its basic info.
 
 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.
 
 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

◆ __construct()

base_optigroup::__construct ( $name,
$elements = null,
$multiple = false )

Constructor - instantiates one base_optigroup, specifying its basic info.

Parameters
string$namename of the element
array$elementsbase_optigroup_elements of this group
bool$multipleto decide if the group allows multiple branches processing or no

Reimplemented from base_nested_element.

Member Function Documentation

◆ add_attributes()

base_optigroup::add_attributes ( $attributes)

Adding attributes is forbidden.

Reimplemented from base_final_element.

◆ add_final_elements()

base_optigroup::add_final_elements ( $attributes)

Adding final elements is forbidden.

Reimplemented from base_nested_element.

◆ add_used()

base_optigroup::add_used ( $element)
protected

Recalculate all the used elements in the optigroup, observing restrictions and passing the new used to outer level.

Reimplemented from base_nested_element.

◆ clean_value()

base_nested_element::clean_value ( )
inherited

Reimplemented from base_atom.

◆ clean_values()

base_nested_element::clean_values ( )
inherited

Reimplemented from base_final_element.

◆ destroy()

base_nested_element::destroy ( )
inherited

Destroy all circular references.

It helps PHP 5.2 a lot!

Reimplemented from base_final_element.

◆ get_level()

base_optigroup::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.

Reimplemented from base_final_element.

◆ get_new_attribute()

base_optigroup::get_new_attribute ( $name)
protected

Instantiating attributes is forbidden.

Reimplemented from base_final_element.

◆ get_new_final_element()

base_optigroup::get_new_final_element ( $name)
protected

Instantiating final elements is forbidden.

Reimplemented from base_nested_element.

◆ get_value()

base_nested_element::get_value ( )
inherited

Reimplemented from base_atom.

◆ set_parent()

base_optigroup::set_parent ( $element)
protected

Set the parent of the optigroup and, at the same time, process all the condition params in all the childs.

Reimplemented from base_final_element.

◆ set_value()

base_nested_element::set_value ( $value)
inherited

Reimplemented from base_atom.

◆ to_string()

base_optigroup::to_string ( $showvalue = false)

Reimplemented from base_nested_element.


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