backup_helper Class Reference

Inheritance diagram for backup_helper:

Static Public Member Functions
static	check_and_create_backup_dir ($backupid)
static	clear_backup_dir ($backupid)
static	delete_backup_dir ($backupid)
static	delete_dir_contents ($dir, $excludeddir='')
static	delete_old_backup_dirs ($deletefrom)
static	log ($message, $level, $a, $depth, $display, $logger)
static	store_backup_file ($backupid, $filepath)
static	is_sqlparam ($value)
static	get_inforef_itemnames ()

---

Detailed Description

Base abstract class for all the helper classes providing various operations

TODO: Finish phpdocs

Definition at line 30 of file backup_helper.class.php.

---

Member Function Documentation

static check_and_create_backup_dir

(

$

backupid

)

[static]

Given one backupid, create all the needed dirs to have one backup temp dir available

Definition at line 35 of file backup_helper.class.php.

Here is the call graph for this function:

static clear_backup_dir

(

$

backupid

)

[static]

Given one backupid, ensure its temp dir is completely empty

Definition at line 45 of file backup_helper.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static delete_backup_dir

(

$

backupid

)

[static]

Given one backupid, delete completely its temp dir

Definition at line 56 of file backup_helper.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static delete_dir_contents	(	$	dir,
		$	excludeddir = ''
	)		[static]

Given one fullpath to directory, delete its contents recursively Copied originally from somewhere in the net. TODO: Modernise this

Definition at line 67 of file backup_helper.class.php.

Here is the call graph for this function:

static delete_old_backup_dirs

(

$

deletefrom

)

[static]

Delete all the temp dirs older than the time specified

Definition at line 130 of file backup_helper.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static get_inforef_itemnames

(

)

[static]

This function returns one array of itemnames that are being handled by inforef.xml files. Used both by backup and restore

Definition at line 295 of file backup_helper.class.php.

Here is the caller graph for this function:

static is_sqlparam

(

$

value

)

[static]

This function simply marks one param to be considered as straight sql param, so it won't be searched in the structure tree nor converted at all. Useful for better integration of definition of sources in structure and DB stuff

Definition at line 287 of file backup_helper.class.php.

Here is the caller graph for this function:

static log	(	$	message,
		$	level,
		$	a,
		$	depth,
		$	display,
		$	logger
	)		[static]

This function will be invoked by any log() method in backup/restore, acting as a simple forwarder to the standard loggers but also, if the $display parameter is true, supporting translation via get_string() and sending to standard output.

Definition at line 161 of file backup_helper.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static store_backup_file	(	$	backupid,
		$	filepath
	)		[static]

Given one backupid and the (FS) final generated file, perform its final storage into Moodle file storage. For stored files it returns the complete file_info object

Definition at line 180 of file backup_helper.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• C:/xampp/htdocs/moodle/backup/util/helper/backup_helper.class.php