base_final_element Class Reference

Abstract class representing one final element atom (name/value/parent) piece of information. More...

Inheritance diagram for base_final_element:

Public Member Functions
	__construct ($name, $attributes=null)
	Constructor - instantiates one base_final_element, specifying its basic info.
	add_attributes ($attributes)
	clean_value ()
	clean_values ()
	destroy ()
	Destroy all circular references.
	get_attribute ($name)
	get_attributes ()
	Public API starts here.
	get_level ()
	get_name ()
	Public API starts here.
	get_parent ()
	get_value ()
	is_set ()
	set_value ($value)
	to_string ($showvalue=false)

Protected Member Functions
	find_element_by_path ($path)
	find_first_parent_by_name ($name)
	get_grandoptigroupelement_or_grandparent ()
	get_grandparent ()
	get_new_attribute ($name)
	Returns one instace of the @base_attribute class to work with when attributes are added simply by name.
	set_parent ($element)
	validate_name ($name)

Detailed Description

Abstract class representing one final element atom (name/value/parent) piece of information.

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

base_final_element::__construct	(		$name,
			$attributes = null )

Constructor - instantiates one base_final_element, specifying its basic info.

Parameters

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

Reimplemented in encrypted_final_element.

Member Function Documentation

add_attributes()

base_final_element::add_attributes

(

$attributes

)

Reimplemented in backup_optigroup_element, and base_optigroup.

destroy()

base_final_element::destroy

(

)

Destroy all circular references.

It helps PHP 5.2 a lot!

Reimplemented in base_nested_element.

get_level()

base_final_element::get_level

(

)

Reimplemented in backup_optigroup_element, and base_optigroup.

get_new_attribute()

base_final_element::get_new_attribute ( $name )

abstractprotected

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

Reimplemented in backup_final_element, backup_nested_element, backup_optigroup_element, and base_optigroup.

set_parent()

base_final_element::set_parent ( $element )

protected

Reimplemented in backup_optigroup_element, and base_optigroup.

set_value()

base_atom::set_value ( $value )

inherited

Reimplemented in base64_encode_final_element, and encrypted_final_element.

to_string()

base_final_element::to_string

(

$showvalue = false

)

Reimplemented from base_atom.

---

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

• backup/util/structure/base_final_element.class.php