76aeead83ca5bdb40cf41778913744bbbf116ed8
[moodle.git] / lib / filestorage / file_packer.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Abstraction of general file packer.
20  *
21  * @package   core_files
22  * @copyright 2008 Petr Skoda (http://skodak.org)
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * Abstract class for archiving of files.
30  *
31  * @package   core_files
32  * @copyright 2008 Petr Skoda (http://skodak.org)
33  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 abstract class file_packer {
37     /**
38      * Archive files and store the result in file storage
39      *
40      * @param array $files array with zip paths as keys (archivepath=>ospathname or archivepath=>stored_file)
41      * @param int $contextid context ID
42      * @param string $component component
43      * @param string $filearea file area
44      * @param int $itemid item ID
45      * @param string $filepath file path
46      * @param string $filename file name
47      * @param int $userid user ID
48      * @return stored_file|bool false if error stored file instance if ok
49      */
50     public abstract function archive_to_storage($files, $contextid, $component, $filearea, $itemid, $filepath, $filename, $userid = NULL);
52     /**
53      * Archive files and store the result in os file
54      *
55      * @param array $files array with zip paths as keys (archivepath=>ospathname or archivepath=>stored_file)
56      * @param string $archivefile path to target zip file
57      * @return bool success
58      */
59     public abstract function archive_to_pathname($files, $archivefile);
61     /**
62      * Extract file to given file path (real OS filesystem), existing files are overwrited
63      *
64      * @param stored_file|string $archivefile full pathname of zip file or stored_file instance
65      * @param string $pathname target directory
66      * @param array $onlyfiles only extract files present in the array
67      * @return array|bool list of processed files; false if error
68      */
69     public abstract function extract_to_pathname($archivefile, $pathname, array $onlyfiles = NULL);
71     /**
72      * Extract file to given file path (real OS filesystem), existing files are overwrited
73      *
74      * @param string|stored_file $archivefile full pathname of zip file or stored_file instance
75      * @param int $contextid context ID
76      * @param string $component component
77      * @param string $filearea file area
78      * @param int $itemid item ID
79      * @param string $pathbase file path
80      * @param int $userid user ID
81      * @return array|bool list of processed files; false if error
82      */
83     public abstract function extract_to_storage($archivefile, $contextid, $component, $filearea, $itemid, $pathbase, $userid = NULL);
85     /**
86      * Returns array of info about all files in archive
87      *
88      * @param string|file_archive $archivefile
89      * @return array of file infos
90      */
91     public abstract function list_files($archivefile);
92 }