backup_final_element Class Reference

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

Inheritance diagram for backup_final_element:

Public Member Functions
	add_attributes ($attributes)
	annotate ($backupid)
	This function implements the annotation of the current value associating it with $itemname.
	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 ()
	process ($processor)
	This function will call to the corresponding processor method in other to make them perform the desired tasks.
	set_annotation_item ($itemname)
	This function sets the $itemname to be used when annotating.
	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)

Protected Attributes
	$annotationitem

Detailed Description

Instantiable class representing one final element atom (name/value/parent) 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

Member Function Documentation

add_attributes()

base_final_element::add_attributes ( $attributes )

inherited

Reimplemented in backup_optigroup_element, and base_optigroup.

annotate()

backup_final_element::annotate

(

$backupid

)

This function implements the annotation of the current value associating it with $itemname.

Implements annotable.

destroy()

base_final_element::destroy ( )

inherited

Destroy all circular references.

It helps PHP 5.2 a lot!

Reimplemented in base_nested_element.

get_level()

base_final_element::get_level ( )

inherited

Reimplemented in backup_optigroup_element, and base_optigroup.

get_new_attribute()

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

process()

backup_final_element::process

(

$processor

)

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

Implements processable.

set_annotation_item()

backup_final_element::set_annotation_item

(

$itemname

)

This function sets the $itemname to be used when annotating.

Implements annotable.

set_parent()

base_final_element::set_parent ( $element )

protectedinherited

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 )

inherited

Reimplemented from base_atom.

---

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

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