file_packer Class Reference

Abstract class for archiving of files. More...

Inheritance diagram for file_packer:

Public Member Functions
	archive_to_pathname (array $files, $archivefile, $ignoreinvalidfiles=true, file_progress $progress=null)
	Archive files and store the result in 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.

Detailed Description

Abstract class for archiving of files.

Copyright

2008 Petr Skoda (http://skodak.org)

License

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

Member Function Documentation

archive_to_pathname()

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

abstract

Archive files and store the result in os file.

The key of the $files array is always the path within the archive, e.g. 'folder/subfolder/file.txt'. There are several options for the values of the array:

• null = this entry represents a directory, so no file
• string = full path to file within operating system filesystem
• stored_file = file within Moodle filesystem
• array with one string element = use in-memory string for file content

For the string (OS path) and stored_file (Moodle filesystem) cases, you can specify a directory instead of a file to recursively include all files within this directory.

Parameters

array	$files	array with zip paths as keys (archivepath=>ospathname or archivepath=>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

Reimplemented in mbz_packer, tgz_packer, and zip_packer.

archive_to_storage()

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

abstract

Archive files and store the result in file storage.

The key of the $files array is always the path within the archive, e.g. 'folder/subfolder/file.txt'. There are several options for the values of the array:

• null = this entry represents a directory, so no file
• string = full path to file within operating system filesystem
• stored_file = file within Moodle filesystem
• array with one string element = use in-memory string for file content

For the string (OS path) and stored_file (Moodle filesystem) cases, you can specify a directory instead of a file to recursively include all files within this directory.

Parameters

array	$files	Array of files to archive
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

Reimplemented in mbz_packer, tgz_packer, and zip_packer.

extract_to_pathname()

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

abstract

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|bool

list of processed files; false if error

Reimplemented in mbz_packer, tgz_packer, and zip_packer.

extract_to_storage()

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

abstract

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|bool

list of processed files; false if error

Reimplemented in mbz_packer, tgz_packer, and zip_packer.

list_files()

file_packer::list_files ( $archivefile )

abstract

Returns array of info about all files in archive.

Parameters

string | file_archive

$archivefile

Return values

array

of file infos

Reimplemented in mbz_packer, tgz_packer, and zip_packer.

---

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

• lib/filestorage/file_packer.php