Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
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:
backup_attribute backup_final_element anonymizer_final_element base64_encode_final_element encrypted_final_element mnethosturl_final_element

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.

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: