Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
backup_logstore_database_nested_element Class Reference
Inheritance diagram for backup_logstore_database_nested_element:
backup_nested_element base_nested_element processable base_final_element base_atom

Public Member Functions

 __construct ($name, $attributes=null, $finalelements=null)
 Constructor - instantiates one backup_nested_element, specifying its basic info. More...
 
 add_attributes ($attributes)
 
 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 ()
 
 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_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 ()
 
 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_db ()
 Get the database we want to use. More...
 
 get_source_sql ()
 
 get_source_table ()
 
 get_source_table_sortby ()
 
 get_value ()
 
 is_set ()
 
 process ($processor)
 Process the nested element. More...
 
 set_source_alias ($dbname, $finalelementname)
 
 set_source_array ($arr)
 
 set_source_db ($db)
 Set the database we want to use. More...
 
 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. 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)
 For sql or table datasources, this will iterate over the "external" DB connection stored in this class instead of the default $DB. More...
 
 get_new_attribute ($name)
 Returns one instace of the @base_attribute class to work with when attributes are added simply by name. More...
 
 get_new_final_element ($name)
 Returns one instace of the @final_element class to work with when final_elements are added simply by name. More...
 
 get_used ()
 
 set_parent ($element)
 
 set_used ($used)
 
 validate_name ($name)
 

Protected Attributes

 $aliases
 
 $counter
 
 $fileannotations
 
 $logs
 
 $params
 
 $procparams
 
 $results
 
moodle_database $sourcedb
 $sourcedb
 
 $sql
 
 $table
 
 $tablesortby
 
 $var_array
 

Constructor & Destructor Documentation

◆ __construct()

backup_logstore_database_nested_element::__construct (   $name,
  $attributes = null,
  $finalelements = null 
)

Constructor - instantiates one backup_nested_element, specifying its basic info.

Parameters
string$namename of the element
array$attributesattributes this element will handle (optional, defaults to null)
array$finalelementsthis element will handle (optional, defaults to null)

Reimplemented from backup_nested_element.

Member Function Documentation

◆ add_attributes()

base_final_element::add_attributes (   $attributes)
inherited

Reimplemented in backup_optigroup_element, and base_optigroup.

◆ add_final_elements()

base_nested_element::add_final_elements (   $final_elements)
inherited

Reimplemented in base_optigroup.

◆ 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$messageto add to the logs
int$levellevel of importance backup::LOG_DEBUG and other constants
mixed$ato be included in $message
int$depthof the message
display$boolsupporting translation via get_string() if true
Return values
void

◆ add_result()

backup_nested_element::add_result (   $result)
protectedinherited

Saves the results to an array.

Parameters
array$resultassociative array
Return values
void

◆ add_used()

base_nested_element::add_used (   $element)
protectedinherited

Reimplemented in base_optigroup.

◆ 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.

◆ 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_logstore_database_nested_element::get_iterator (   $processor)
protected

For sql or table datasources, this will iterate over the "external" DB connection stored in this class instead of the default $DB.

All other cases use the parent default.

Parameters
object$processorthe processor

Reimplemented from backup_nested_element.

◆ get_level()

base_final_element::get_level ( )
inherited

Reimplemented in backup_optigroup_element, and base_optigroup.

◆ get_logs()

backup_nested_element::get_logs ( )
inherited

Returns the logs.

Return values
arrayof log objects

◆ get_new_attribute()

backup_nested_element::get_new_attribute (   $name)
protectedinherited

Returns one instace of the @base_attribute class to work with when attributes are added simply by name.

Reimplemented from base_final_element.

Reimplemented in backup_optigroup_element.

◆ get_new_final_element()

backup_nested_element::get_new_final_element (   $name)
protectedinherited

Returns one instace of the @final_element class to work with when final_elements are added simply by name.

Reimplemented from base_nested_element.

Reimplemented in backup_optigroup_element.

◆ get_results()

backup_nested_element::get_results ( )
inherited

Returns the results.

Return values
associativearray of results

◆ get_source_db()

backup_logstore_database_nested_element::get_source_db ( )

Get the database we want to use.

Return values
moodle_database::$db

◆ get_value()

base_nested_element::get_value ( )
inherited

Reimplemented from base_atom.

◆ process()

backup_nested_element::process (   $processor)
inherited

Process the nested element.

Parameters
object$processorthe processor
Return values
void

Implements processable.

Reimplemented in file_nested_element, and backup_optigroup_element.

◆ set_parent()

base_final_element::set_parent (   $element)
protectedinherited

Reimplemented in backup_optigroup_element, and base_optigroup.

◆ set_source_db()

backup_logstore_database_nested_element::set_source_db (   $db)

Set the database we want to use.

Parameters
moodle_database$db

◆ set_value()

base_nested_element::set_value (   $value)
inherited

Reimplemented from base_atom.

◆ to_string()

base_nested_element::to_string (   $showvalue = false)
inherited

Reimplemented from base_final_element.


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