mirror of
https://github.com/moodle/moodle.git
synced 2025-01-18 22:08:20 +01:00
78 lines
2.8 KiB
PHP
78 lines
2.8 KiB
PHP
<?php
|
|
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
/**
|
|
* Abstraction of general file packer.
|
|
*
|
|
* @package moodlecore
|
|
* @subpackage file-packer
|
|
* @copyright 2008 Petr Skoda (http://skodak.org)
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
/**
|
|
* Abstract class for archiving of files.
|
|
*/
|
|
abstract class file_packer {
|
|
|
|
/**
|
|
* Archive files and store the result in file storage
|
|
* @param array $files array with zip paths as keys (archivepath=>ospathname or archivepath=>stored_file)
|
|
* @param int $contextid
|
|
* @param string $filearea
|
|
* @param int $itemid
|
|
* @param string $filepath
|
|
* @param string $filename
|
|
* @return mixed false if error stored file instance if ok
|
|
*/
|
|
public abstract function archive_to_storage($files, $contextid, $filearea, $itemid, $filepath, $filename, $userid=null);
|
|
|
|
/**
|
|
* Archive files and store the result in os file
|
|
* @param array $files array with zip paths as keys (archivepath=>ospathname or archivepath=>stored_file)
|
|
* @param string $archivefile path to target zip file
|
|
* @return bool success
|
|
*/
|
|
public abstract function archive_to_pathname($files, $archivefile);
|
|
|
|
/**
|
|
* Extract file to given file path (real OS filesystem), existing files are overwrited
|
|
* @param mixed $archivefile full pathname of zip file or stored_file instance
|
|
* @param string $pathname target directory
|
|
* @return mixed list of processed files; false if error
|
|
*/
|
|
public abstract function extract_to_pathname($archivefile, $pathname);
|
|
|
|
/**
|
|
* Extract file to given file path (real OS filesystem), existing files are overwrited
|
|
* @param mixed $archivefile full pathname of zip file or stored_file instance
|
|
* @param int $contextid
|
|
* @param string $filearea
|
|
* @param int $itemid
|
|
* @param string $filepath
|
|
* @return mixed list of processed files; false if error
|
|
*/
|
|
public abstract function extract_to_storage($archivefile, $contextid, $filearea, $itemid, $pathbase, $userid=null);
|
|
|
|
/**
|
|
* Returns array of info about all files in archive
|
|
* @return array of file infos
|
|
*/
|
|
public abstract function list_files($archivefile);
|
|
}
|