mirrored from git://git.moodle.org/moodle.git
/
file_info.php
231 lines (201 loc) · 6.37 KB
/
file_info.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<?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/>.
/**
* Base for all file browsing classes.
*
* @package moodlecore
* @subpackage file-browser
* @copyright 2008 Petr Skoda (http://skodak.org)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
/**
* Base class for things in the tree navigated by @see{file_browser}.
*/
abstract class file_info {
protected $context;
protected $browser;
public function __construct($browser, $context) {
$this->browser = $browser;
$this->context = $context;
}
/**
* Returns list of standard virtual file/directory identification.
* The difference from stored_file parameters is that null values
* are allowed in all fields
* @return array with keys contextid, filearea, itemid, filepath and filename
*/
public abstract function get_params();
/**
* Returns localised visible name.
* @return string
*/
public abstract function get_visible_name();
/**
* Is directory?
* @return bool
*/
public abstract function is_directory();
/**
* Does this node have children?
* @return bool
*/
public abstract function get_children();
/**
* Returns parent file_info instance
* @return file_info or null for root
*/
public abstract function get_parent();
/**
* Returns array of url encoded params.
* @return array with numeric keys
*/
public function get_params_rawencoded() {
$params = $this->get_params();
$encoded = array();
$encoded[] = 'contextid='.$params['contextid'];
$encoded[] = 'filearea='.$params['filearea'];
$encoded[] = 'itemid='.(is_null($params['itemid']) ? -1 : $params['itemid']);
$encoded[] = 'filepath='.(is_null($params['filepath']) ? '' : rawurlencode($params['filepath']));
$encoded[] = 'filename='.((is_null($params['filename']) or $params['filename'] === '.') ? '' : rawurlencode($params['filename']));
return $encoded;
}
/**
* Returns download url for
* @param bool $forcedownload
* @param bool $htts force https
* @return string url
*/
public function get_url($forcedownload=false, $https=false) {
return null;
}
/**
* Can I read content of this file or enter directory?
* @return bool
*/
public function is_readable() {
return true;
}
/**
* Can I add new files or directories?
* @return bool
*/
public function is_writable() {
return true;
}
/**
* Returns file size in bytes, null for directories
* @return int bytes or null if not known
*/
public function get_filesize() {
return null;
}
/**
* Returns mimetype
* @return string mimetype or null if not known
*/
public function get_mimetype() {
return null;
}
/**
* Returns time created unix timestamp if known
* @return int timestamp or null
*/
public function get_timecreated() {
return null;
}
/**
* Returns time modified unix timestamp if known
* @return int timestamp or null
*/
public function get_timemodified() {
return null;
}
/**
* Create new directory, may throw exception - make sure
* params are valid.
* @param string $newdirname name of new directory
* @param int id of author, default $USER->id
* @return file_info new directory
*/
public function create_directory($newdirname, $userid=null) {
return null;
}
/**
* Create new file from string - make sure
* params are valid.
* @param string $newfilename name of new file
* @param string $content of file
* @param int id of author, default $USER->id
* @return file_info new file
*/
public function create_file_from_string($newfilename, $content, $userid=null) {
return null;
}
/**
* Create new file from pathname - make sure
* params are valid.
* @param string $newfilename name of new file
* @param string $pathname location of file
* @param int id of author, default $USER->id
* @return file_info new file
*/
public function create_file_from_pathname($newfilename, $pathname, $userid=null) {
return null;
}
/**
* Create new file from stored file - make sure
* params are valid.
* @param string $newfilename name of new file
* @param mixed dile id or stored_file of file
* @param int id of author, default $USER->id
* @return file_info new file
*/
public function create_file_from_storedfile($newfilename, $fid, $userid=null) {
return null;
}
/**
* Delete file, make sure file is deletable first.
* @return bool success
*/
public function delete() {
return false;
}
/**
* Copy content of this file to local storage, overriding current file if needed.
* @param int $contextid
* @param string $filearea
* @param int $itemid
* @param string $filepath
* @param string $filename
* @return boolean success
*/
public function copy_to_storage($contextid, $filearea, $itemid, $filepath, $filename) {
return false;
}
/**
* Copy content of this file to local storage, overriding current file if needed.
* @param string $pathname real local full file name
* @return boolean success
*/
public function copy_to_pathname($pathname) {
return false;
}
//TODO: following methods are not implemented yet ;-)
//public abstract function move(location params);
//public abstract function rename(new name);
//public abstract function unzip(location params);
//public abstract function zip(zip file, file info);
}