annotable Interface Reference

Interface to apply to all the classes we want to be annotable in the backup/restore process. More...

Inheritance diagram for annotable:

Public Member Functions
	annotate ($backupid)
	This function implements the annotation of the current value associating it with $itemname.
	set_annotation_item ($itemname)
	This function sets the $itemname to be used when annotating.

Detailed Description

Interface to apply to all the classes we want to be annotable in the backup/restore process.

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

annotate()

annotable::annotate

(

$backupid

)

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

Implemented in backup_attribute, and backup_final_element.

set_annotation_item()

annotable::set_annotation_item

(

$itemname

)

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

Implemented in backup_attribute, and backup_final_element.

---

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

• backup/util/interfaces/annotable.class.php