backup_structure_dbops Class Reference

Non instantiable helper class providing DB support to the backup_structure stuff. More...

Inheritance diagram for backup_structure_dbops:

Static Public Member Functions
static	annotate_files ($backupid, $contextid, $component, $filearea, $itemid, core\progress\base $progress=null)
	Adds backup id database record for all files in the given file area. More...
static	annotations_exist ($backupid, $itemname)
	Returns true/false if there are annotations for a given item.
static	convert_params_to_values ($params, $processor)
static	get_iterator ($element, $params, $processor)
static	insert_backup_ids_record ($backupid, $itemname, $itemid)
static	move_annotations_to_final ($backupid, $itemname, core\progress\base $progress)
	Moves all the existing 'item' annotations to their final 'itemfinal' ones for a given backup. More...

Detailed Description

Non instantiable helper class providing DB support to the backup_structure stuff.

This class contains various static methods available for all the DB operations performed by the backup_structure stuff (mainly @backup_nested_element class)

TODO: Finish phpdocs

Member Function Documentation

annotate_files()

static backup_structure_dbops::annotate_files (   $backupid,   $contextid,   $component,   $filearea,   $itemid, core\progress\base  $progress = null  )

static

Adds backup id database record for all files in the given file area.

Parameters

string	$backupid	Backup ID
int	$contextid	Context id
string	$component	Component
string	$filearea	File area
int	$itemid	Item id
core\progress\base	$progress

move_annotations_to_final()

static backup_structure_dbops::move_annotations_to_final (   $backupid,   $itemname, core\progress\base  $progress  )

static

Moves all the existing 'item' annotations to their final 'itemfinal' ones for a given backup.

Parameters

string	$backupid	Backup ID
string	$itemname	Item name
core\progress\base	$progress	Progress tracker

---

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

• backup/util/dbops/backup_structure_dbops.class.php