backup_nested_element Class Reference

Inheritance diagram for backup_nested_element:

Collaboration diagram for backup_nested_element:

Public Member Functions
	__construct ($name, $attributes=null, $final_elements=null)
	process ($processor)
	set_source_array ($arr)
	set_source_table ($table, $params)
	set_source_sql ($sql, $params)
	set_source_alias ($dbname, $finalelementname)
	annotate_files ($component, $filearea, $elementname, $filesctxid=null)
	annotate_ids ($itemname, $elementname)
	get_file_annotations ()
	get_source_array ()
	get_source_table ()
	get_source_sql ()
	get_counter ()
	fill_values ($values)
Protected Member Functions
	convert_table_params ($params)
	convert_sql_params ($params)
	find_element ($param)
	get_new_attribute ($name)
	get_new_final_element ($name)
	get_iterator ($processor)
Protected Attributes
	$var_array
	$table
	$sql
	$params
	$procparams
	$aliases
	$fileannotations
	$counter

---

Detailed Description

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

Definition at line 30 of file backup_nested_element.class.php.

---

Constructor & Destructor Documentation

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

Definition at line 48 of file backup_nested_element.class.php.

---

Member Function Documentation

annotate_files	(	$	component,
		$	filearea,
		$	elementname,
		$	filesctxid = null
	)

Definition at line 149 of file backup_nested_element.class.php.

Here is the call graph for this function:

annotate_ids	(	$	itemname,
		$	elementname
	)

Definition at line 168 of file backup_nested_element.class.php.

Here is the call graph for this function:

convert_sql_params

(

$

params

)

[protected]

Definition at line 234 of file backup_nested_element.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

convert_table_params

(

$

params

)

[protected]

Definition at line 230 of file backup_nested_element.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Reimplemented in file_nested_element.

Definition at line 202 of file backup_nested_element.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

find_element

(

$

param

)

[protected]

Definition at line 242 of file backup_nested_element.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_counter

(

)

Definition at line 193 of file backup_nested_element.class.php.

get_file_annotations

(

)

Returns one array containing the element in the and the areas to be searched

Definition at line 177 of file backup_nested_element.class.php.

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

Definition at line 276 of file backup_nested_element.class.php.

Here is the caller graph for this function:

get_new_attribute

(

$

name

)

[protected]

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

Reimplemented from base_final_element.

Reimplemented in backup_optigroup_element.

Definition at line 260 of file backup_nested_element.class.php.

get_new_final_element

(

$

name

)

[protected]

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

Reimplemented from base_nested_element.

Reimplemented in backup_optigroup_element.

Definition at line 268 of file backup_nested_element.class.php.

get_source_array

(

)

Definition at line 181 of file backup_nested_element.class.php.

get_source_sql

(

)

Definition at line 189 of file backup_nested_element.class.php.

get_source_table

(

)

Definition at line 185 of file backup_nested_element.class.php.

process

(

$

processor

)

This function will call to the corresponding processor method in other to make them perform the desired tasks.

Implements processable.

Reimplemented in backup_optigroup_element, and file_nested_element.

Definition at line 60 of file backup_nested_element.class.php.

Here is the call graph for this function:

set_source_alias	(	$	dbname,
		$	finalelementname
	)

Definition at line 139 of file backup_nested_element.class.php.

Here is the call graph for this function:

set_source_array

(

$

arr

)

Definition at line 116 of file backup_nested_element.class.php.

set_source_sql	(	$	sql,
		$	params
	)

Definition at line 130 of file backup_nested_element.class.php.

Here is the call graph for this function:

set_source_table	(	$	table,
		$	params
	)

Definition at line 121 of file backup_nested_element.class.php.

Here is the call graph for this function:

---

Field Documentation

$aliases [protected]

Definition at line 37 of file backup_nested_element.class.php.

$counter [protected]

Definition at line 39 of file backup_nested_element.class.php.

$fileannotations [protected]

Definition at line 38 of file backup_nested_element.class.php.

$params [protected]

Definition at line 35 of file backup_nested_element.class.php.

$procparams [protected]

Definition at line 36 of file backup_nested_element.class.php.

$sql [protected]

Definition at line 34 of file backup_nested_element.class.php.

$table [protected]

Definition at line 33 of file backup_nested_element.class.php.

$var_array [protected]

Definition at line 32 of file backup_nested_element.class.php.

---

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

• C:/xampp/htdocs/moodle/backup/util/structure/backup_nested_element.class.php