Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
backup_attribute Class Reference

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

Inheritance diagram for backup_attribute:
base_attribute processable annotable base_atom

Public Member Functions

 annotate ($backupid)
 This function implements the annotation of the current value associating it with $itemname.
 
 clean_value ()
 
 get_name ()
 Public API starts here.
 
 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

 validate_name ($name)
 

Protected Attributes

 $annotationitem
 

Detailed Description

Instantiable class representing one attribute atom (name/value) piece of information on backup.

Member Function Documentation

◆ annotate()

backup_attribute::annotate ( $backupid)

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

Implements annotable.

◆ process()

backup_attribute::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_attribute::set_annotation_item ( $itemname)

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

Implements annotable.

◆ set_value()

base_atom::set_value ( $value)
inherited

◆ to_string()

base_attribute::to_string ( $showvalue = false)
inherited

Reimplemented from base_atom.


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