Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
|
Instantiable class representing one optigroup element for conditional branching. More...
Public Member Functions | |
__construct ($name, $final_elements=null, $conditionparam=null, $conditionvalue=null) | |
Constructor - instantiates one backup_optigroup_element. | |
add_add_optigroup ($optigroup) | |
Adding optigroups is forbidden. | |
add_attributes ($attributes) | |
Adding attributes is forbidden. | |
add_child ($element) | |
add_final_elements ($final_elements) | |
add_optigroup ($optigroup) | |
annotate_files ($component, $filearea, $elementname, $filesctxid=null) | |
annotate_ids ($itemname, $elementname) | |
clean_value () | |
clean_values () | |
condition_matches () | |
Evaluate the condition, returning if matches (true) or no (false) | |
destroy () | |
Destroy all circular references. | |
fill_values ($values) | |
Simple filler that, matching by name, will fill both attributes and final elements depending of this nested element, debugging info about non-matching elements and/or elements present in both places. | |
get_attribute ($name) | |
get_attributes () | |
Public API starts here. | |
get_child ($name) | |
get_children () | |
get_condition_param () | |
get_condition_value () | |
get_counter () | |
get_file_annotations () | |
Returns one array containing the element in the @backup_structure and the areas to be searched. | |
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_logs () | |
Returns the logs. | |
get_name () | |
Public API starts here. | |
get_optigroup () | |
get_parent () | |
get_results () | |
Returns the results. | |
get_source_array () | |
get_source_sql () | |
get_source_table () | |
get_source_table_sortby () | |
get_value () | |
is_set () | |
process ($processor) | |
process one optigroup_element | |
set_condition ($conditionparam, $conditionvalue) | |
Sets the condition for this optigroup. | |
set_source_alias ($dbname, $finalelementname) | |
set_source_array ($arr) | |
set_source_sql ($sql, $params) | |
set_source_table ($table, $params, $sortby=null) | |
set_value ($value) | |
to_string ($showvalue=false) | |
Protected Member Functions | |
add_log ($message, $level, $a=null, $depth=null, $display=false) | |
Saves a log message to an array. | |
add_result ($result) | |
Saves the results to an array. | |
add_used ($element) | |
check_and_set_used ($element) | |
convert_sql_params ($params) | |
convert_table_params ($params) | |
find_element ($param) | |
find_element_by_path ($path) | |
find_first_parent_by_name ($name) | |
get_grandoptigroupelement_or_grandparent () | |
get_grandparent () | |
get_iterator ($processor) | |
Returns one PHP iterator over each "ocurrence" of this nested element (array or DB recordset). | |
get_new_attribute ($name) | |
Instantiating attributes is forbidden. | |
get_new_final_element ($name) | |
Returns one instace of the @final_element class to work with when final_elements are added simply by name. | |
get_used () | |
set_parent ($element) | |
Set the parent of the optigroup_element and, at the same time, process the condition param. | |
set_used ($used) | |
validate_name ($name) | |
Instantiable class representing one optigroup element for conditional branching.
Objects of this class are internally nested elements, so they support having both final elements and children (more nested elements) and are able to have one source and all the stuff supported by nested elements. Their main differences are:
Their main use is to allow conditional branching, basically for optional submodules like question types, assignment subtypes... where different subtrees of information must be exported. It's correct to assume that each submodule will define its own optigroup_element for backup purposes.
backup_optigroup_element::__construct | ( | $name, | |
$final_elements = null, | |||
$conditionparam = null, | |||
$conditionvalue = null ) |
Constructor - instantiates one backup_optigroup_element.
string | $name | of the element |
array | $final_elements | this element will handle (optional, defaults to null) |
string | $condition_param | param (path) we are using as source for comparing (optional, defaults to null) |
string | $condition_value | value we are comparing to (optional, defaults to null) |
backup_optigroup_element::add_attributes | ( | $attributes | ) |
Adding attributes is forbidden.
Reimplemented from base_final_element.
|
inherited |
Reimplemented in base_optigroup.
|
protectedinherited |
Saves a log message to an array.
string | $message | to add to the logs |
int | $level | level of importance backup::LOG_DEBUG and other constants |
mixed | $a | to be included in $message |
int | $depth | of the message |
display | $bool | supporting translation via get_string() if true |
void |
|
protectedinherited |
Saves the results to an array.
array | $result | associative array |
void |
|
protectedinherited |
Reimplemented in base_optigroup.
|
inherited |
Reimplemented from base_atom.
|
inherited |
Reimplemented from base_final_element.
|
inherited |
|
inherited |
Simple filler that, matching by name, will fill both attributes and final elements depending of this nested element, debugging info about non-matching elements and/or elements present in both places.
Accept both arrays and objects.
|
protectedinherited |
Returns one PHP iterator over each "ocurrence" of this nested element (array or DB recordset).
Delegated to backup_structure_dbops class
Reimplemented in backup_logstore_database_nested_element.
backup_optigroup_element::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.
|
inherited |
Returns the logs.
array | of log objects |
|
protected |
Instantiating attributes is forbidden.
Reimplemented from backup_nested_element.
|
protected |
Returns one instace of the @final_element class to work with when final_elements are added simply by name.
Reimplemented from backup_nested_element.
|
inherited |
Returns the results.
associative | array of results |
|
inherited |
Reimplemented from base_atom.
backup_optigroup_element::process | ( | $processor | ) |
process one optigroup_element
Note that this ONLY processes the final elements in order to get all them before processing any nested element. Pending nested elements are processed by the optigroup caller.
Reimplemented from backup_nested_element.
|
protected |
Set the parent of the optigroup_element and, at the same time, process the condition param.
Reimplemented from base_final_element.
|
inherited |
Reimplemented from base_atom.
|
inherited |
Reimplemented from base_final_element.