Instantiable class representing one nestable element (non final) piece of information on backup. More...

Inheritance diagram for backup_nested_element:

Public Member Functions
	__construct ($name, $attributes=null, $final_elements=null)
	Constructor - instantiates one backup_nested_element, specifying its basic info.

	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.

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

	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 the nested element.

	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)
	Returns one instace of the @base_attribute class to work with when attributes are added simply by name.

	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_used ($used)

	validate_name ($name)

Protected Attributes
array	$aliases

int	$counter

array	$fileannotations

stdClass[]	$logs

mixed	$params

array	$procparams

array	$results

string	$sql

string	$table

string	$tablesortby

array	$var_array
	To be used in case we pass one in-memory structure.

Detailed Description

Instantiable class representing one nestable element (non final) piece of information on backup.

Copyright: 2010 onwards Eloy Lafuente (stronk7)

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

TODO: Finish phpdocs

Constructor & Destructor Documentation

◆ __construct()

backup_nested_element::__construct	(	$name,
		$attributes = null,
		$final_elements = null )

Constructor - instantiates one backup_nested_element, specifying its basic info.

Parameters

string	$name	name of the element
array	$attributes	attributes this element will handle (optional, defaults to null)
array	$final_elements	this element will handle (optional, defaults to null)

Reimplemented from base_nested_element.

Reimplemented in backup_logstore_database_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 )

protected

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

void

◆ add_result()

backup_nested_element::add_result ( $result )

protected

Saves the results to an array.

Parameters

array $result associative 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 )

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.

◆ get_iterator()

backup_nested_element::get_iterator ( $processor )

protected

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.

◆ get_level()

base_final_element::get_level ( )

inherited

Reimplemented in backup_optigroup_element, and base_optigroup.

◆ get_logs()

backup_nested_element::get_logs ( )

Returns the logs.

Return values

array of log objects

◆ get_new_attribute()

backup_nested_element::get_new_attribute ( $name )

protected

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 )

protected

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 ( )

Returns the results.

Return values

associative array of results

◆ get_value()

base_nested_element::get_value ( )

inherited

Reimplemented from base_atom.

◆ process()

backup_nested_element::process ( $processor )

Process the nested element.

Parameters

object $processor the processor

Return values

void

Implements processable.

Reimplemented in backup_optigroup_element.

◆ set_parent()

base_final_element::set_parent ( $element )

protectedinherited

Reimplemented in backup_optigroup_element, and base_optigroup.

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

backup/util/structure/backup_nested_element.class.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add_attributes()

◆ add_final_elements()

◆ add_log()

◆ add_result()

◆ add_used()

◆ clean_value()

◆ clean_values()

◆ destroy()

◆ fill_values()

◆ get_iterator()

◆ get_level()

◆ get_logs()

◆ get_new_attribute()

◆ get_new_final_element()

◆ get_results()

◆ get_value()

◆ process()

◆ set_parent()

◆ set_value()

◆ to_string()