mbz_packer Class Reference

Utility class - handles all packing/unpacking of .mbz files. More...

Inheritance diagram for mbz_packer:

Public Member Functions
	archive_to_pathname (array $files, $archivefile, $ignoreinvalidfiles=true, ?file_progress $progress=null)
	Archive files and store the result in an OS file.
	archive_to_storage (array $files, $contextid, $component, $filearea, $itemid, $filepath, $filename, $userid=null, $ignoreinvalidfiles=true, ?file_progress $progress=null)
	Archive files and store the result in file storage.
	extract_to_pathname ($archivefile, $pathname, ?array $onlyfiles=null, ?file_progress $progress=null, $returnbool=false)
	Extract file to given file path (real OS filesystem), existing files are overwritten.
	extract_to_storage ($archivefile, $contextid, $component, $filearea, $itemid, $pathbase, $userid=null, ?file_progress $progress=null)
	Extract file to given file path (real OS filesystem), existing files are overwritten.
	list_files ($archivefile)
	Returns array of info about all files in archive.

Protected Member Functions
	get_packer_for_archive_operation ()
	Selects appropriate packer for new archive depending on system option and whether required extension is available.
	get_packer_for_read_operation ($archivefile)
	Selects appropriate packer for existing archive depending on file contents.

Detailed Description

Utility class - handles all packing/unpacking of .mbz files.

Copyright

2013 The Open University

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

archive_to_pathname()

mbz_packer::archive_to_pathname	(	array	$files,
			$archivefile,
			$ignoreinvalidfiles = true,
		?file_progress	$progress = null )

Archive files and store the result in an OS file.

Parameters

array	$files	array from archive path => pathname or stored_file
string	$archivefile	path to target zip file
bool	$ignoreinvalidfiles	true means ignore missing or invalid files, false means abort on any error
file_progress	$progress	Progress indicator callback or null if not required

Return values

bool	true if file created, false if not

Exceptions

coding_exception

If any archive paths do not meet the restrictions

Reimplemented from file_packer.

archive_to_storage()

mbz_packer::archive_to_storage	(	array	$files,
			$contextid,
			$component,
			$filearea,
			$itemid,
			$filepath,
			$filename,
			$userid = null,
			$ignoreinvalidfiles = true,
		?file_progress	$progress = null )

Archive files and store the result in file storage.

Any existing file at that location will be overwritten.

Parameters

array	$files	array from archive path => pathname or stored_file
int	$contextid	context ID
string	$component	component
string	$filearea	file area
int	$itemid	item ID
string	$filepath	file path
string	$filename	file name
int	$userid	user ID
bool	$ignoreinvalidfiles	true means ignore missing or invalid files, false means abort on any error
file_progress	$progress	Progress indicator callback or null if not required

Return values

stored_file|bool

false if error stored_file instance if ok

Exceptions

file_exception	If file operations fail
coding_exception	If any archive paths do not meet the restrictions

Reimplemented from file_packer.

extract_to_pathname()

mbz_packer::extract_to_pathname	(		$archivefile,
			$pathname,
		?array	$onlyfiles = null,
		?file_progress	$progress = null,
			$returnbool = false )

Extract file to given file path (real OS filesystem), existing files are overwritten.

Parameters

stored_file | string	$archivefile	full pathname of zip file or stored_file instance
string	$pathname	target directory
array	$onlyfiles	only extract files present in the array
file_progress	$progress	Progress indicator callback or null if not required
bool	$returnbool	Whether to return a basic true/false indicating error state, or full per-file error details.

Return values

array

list of processed files (name=>true)

Exceptions

moodle_exception

If error

Reimplemented from file_packer.

extract_to_storage()

mbz_packer::extract_to_storage	(		$archivefile,
			$contextid,
			$component,
			$filearea,
			$itemid,
			$pathbase,
			$userid = null,
		?file_progress	$progress = null )

Extract file to given file path (real OS filesystem), existing files are overwritten.

Parameters

string | stored_file	$archivefile	full pathname of zip file or stored_file instance
int	$contextid	context ID
string	$component	component
string	$filearea	file area
int	$itemid	item ID
string	$pathbase	file path
int	$userid	user ID
file_progress	$progress	Progress indicator callback or null if not required

Return values

array

list of processed files (name=>true)

Exceptions

moodle_exception

If error

Reimplemented from file_packer.

get_packer_for_archive_operation()

mbz_packer::get_packer_for_archive_operation ( )

protected

Selects appropriate packer for new archive depending on system option and whether required extension is available.

Return values

file_packer

Suitable packer

get_packer_for_read_operation()

mbz_packer::get_packer_for_read_operation ( $archivefile )

protected

Selects appropriate packer for existing archive depending on file contents.

Parameters

string | stored_file

$archivefile

full pathname of zip file or stored_file instance

Return values

file_packer

Suitable packer

list_files()

mbz_packer::list_files

(

$archivefile

)

Returns array of info about all files in archive.

Parameters

string | stored_file

$archivefile

Return values

array

of file infos

Reimplemented from file_packer.

---

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

• lib/filestorage/mbz_packer.php