base_nested_element Class Reference

Inheritance diagram for base_nested_element:

Collaboration diagram for base_nested_element:

Public Member Functions
	__construct ($name, $attributes=null, $final_elements=null)
	destroy ()
	get_final_elements ()
	Public API starts here.
	get_final_element ($name)
	get_children ()
	get_child ($name)
	get_optigroup ()
	add_final_elements ($final_elements)
	add_child ($element)
	add_optigroup ($optigroup)
	get_value ()
	set_value ($value)
	clean_value ()
	clean_values ()
	to_string ($showvalue=false)
Protected Member Functions
	get_used ()
	set_used ($used)
	add_used ($element)
	check_and_set_used ($element)
	get_new_final_element ($name)

---

Detailed Description

Abstract class representing one nestable element (non final) piece of information

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

---

Constructor & Destructor Documentation

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

Constructor - instantiates one base_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 in backup_nested_element, and base_optigroup.

Definition at line 51 of file base_nested_element.class.php.

Here is the call graph for this function:

---

Member Function Documentation

add_child

(

$

element

)

Reimplemented in backup_optigroup.

Definition at line 166 of file base_nested_element.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

add_final_elements

(

$

final_elements

)

Reimplemented in base_optigroup.

Definition at line 143 of file base_nested_element.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

add_optigroup

(

$

optigroup

)

Definition at line 178 of file base_nested_element.class.php.

Here is the call graph for this function:

add_used

(

$

element

)

[protected]

Reimplemented in base_optigroup.

Definition at line 92 of file base_nested_element.class.php.

check_and_set_used

(

$

element

)

[protected]

Definition at line 96 of file base_nested_element.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

clean_value

(

)

Reimplemented from base_atom.

Definition at line 201 of file base_nested_element.class.php.

clean_values

(

)

Reimplemented from base_final_element.

Definition at line 205 of file base_nested_element.class.php.

Here is the caller graph for this function:

destroy

(

)

Destroy all circular references. It helps PHP 5.2 a lot!

Reimplemented from base_final_element.

Definition at line 65 of file base_nested_element.class.php.

get_child

(

$

name

)

Definition at line 131 of file base_nested_element.class.php.

get_children

(

)

Definition at line 127 of file base_nested_element.class.php.

Here is the caller graph for this function:

get_final_element

(

$

name

)

Definition at line 119 of file base_nested_element.class.php.

Here is the caller graph for this function:

get_final_elements

(

)

Public API starts here.

Definition at line 115 of file base_nested_element.class.php.

Here is the caller graph for this function:

get_new_final_element

(

$

name

)

[abstract, protected]

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

Reimplemented in backup_nested_element, backup_optigroup_element, base_optigroup, mock_base_optigroup, and mock_base_nested_element.

Here is the caller graph for this function:

get_optigroup

(

)

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

Here is the caller graph for this function:

get_used

(

)

[protected]

Definition at line 84 of file base_nested_element.class.php.

Here is the caller graph for this function:

get_value

(

)

Reimplemented from base_atom.

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

set_used

(

$

used

)

[protected]

Definition at line 88 of file base_nested_element.class.php.

Here is the caller graph for this function:

set_value

(

$

value

)

Reimplemented from base_atom.

Definition at line 197 of file base_nested_element.class.php.

to_string

(

$

showvalue = false

)

Reimplemented from base_final_element.

Reimplemented in base_optigroup.

Definition at line 222 of file base_nested_element.class.php.

---

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

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