Implementation of backup_optigroup_element to be used by plugins stuff.
More...
|
| 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. More...
|
|
| 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. More...
|
|
| 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. More...
|
|
| get_name () |
| Public API starts here.
|
|
| get_optigroup () |
|
| get_parent () |
|
| get_results () |
| Returns the results. More...
|
|
| get_source_array () |
|
| get_source_sql () |
|
| get_source_table () |
|
| get_source_table_sortby () |
|
| get_value () |
|
| is_set () |
|
| process ($processor) |
| process one optigroup_element More...
|
|
| 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) |
|
|
| add_log ($message, $level, $a=null, $depth=null, $display=false) |
| Saves a log message to an array. More...
|
|
| add_result ($result) |
| Saves the results to an array. More...
|
|
| 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). More...
|
|
| 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) |
|
|
| $aliases |
|
| $counter |
|
| $fileannotations |
|
| $logs |
|
| $params |
|
| $procparams |
|
| $results |
|
| $sql |
|
| $table |
|
| $tablesortby |
|
| $var_array |
|
Implementation of backup_optigroup_element to be used by plugins stuff.
Split just for better separation and future specialisation
◆ add_log()
backup_nested_element::add_log |
( |
|
$message, |
|
|
|
$level, |
|
|
|
$a = null , |
|
|
|
$depth = null , |
|
|
|
$display = false |
|
) |
| |
|
protectedinherited |
Saves a log message to an array.
- See also
- backup_helper::log()
- Parameters
-
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 |
- Return values
-
◆ add_result()
backup_nested_element::add_result |
( |
|
$result | ) |
|
|
protectedinherited |
Saves the results to an array.
- Parameters
-
array | $result | associative array |
- Return values
-
◆ destroy()
base_nested_element::destroy |
( |
| ) |
|
|
inherited |
Destroy all circular references.
It helps PHP 5.2 a lot!
Reimplemented from base_final_element.
◆ fill_values()
backup_nested_element::fill_values |
( |
|
$values | ) |
|
|
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.
Reimplemented in file_nested_element.
◆ get_iterator()
backup_nested_element::get_iterator |
( |
|
$processor | ) |
|
|
protectedinherited |
◆ get_logs()
backup_nested_element::get_logs |
( |
| ) |
|
|
inherited |
Returns the logs.
- Return values
-
◆ get_results()
backup_nested_element::get_results |
( |
| ) |
|
|
inherited |
Returns the results.
- Return values
-
associative | array of results |
◆ process()
backup_optigroup_element::process |
( |
|
$processor | ) |
|
|
inherited |
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.
The documentation for this class was generated from the following file: