mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 14:27:22 +01:00
322 lines
8.5 KiB
PHP
322 lines
8.5 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/>.
|
|
|
|
|
|
/**
|
|
* Base for all file browsing classes.
|
|
*
|
|
* @package core_files
|
|
* @copyright 2008 Petr Skoda (http://skodak.org)
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Base class for things in the tree navigated by {@link file_browser}.
|
|
*
|
|
* @package core_files
|
|
* @copyright 2008 Petr Skoda (http://skodak.org)
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
abstract class file_info {
|
|
|
|
/** @var stdClass File context */
|
|
protected $context;
|
|
|
|
/** @var file_browser File browser instance */
|
|
protected $browser;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param file_browser $browser file_browser instance
|
|
* @param stdClass $context
|
|
*/
|
|
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, component, filearea, itemid, filepath and filename
|
|
*/
|
|
public function get_params() {
|
|
return array('contextid' => $this->context->id,
|
|
'component' => null,
|
|
'filearea' => null,
|
|
'itemid' => null,
|
|
'filepath' => null,
|
|
'filename' => null);
|
|
}
|
|
|
|
/**
|
|
* Returns localised visible name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public abstract function get_visible_name();
|
|
|
|
/**
|
|
* Whether or not this is a directory
|
|
*
|
|
* @return bool
|
|
*/
|
|
public abstract function is_directory();
|
|
|
|
/**
|
|
* Returns list of children.
|
|
*
|
|
* @return array of file_info instances
|
|
*/
|
|
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[] = 'component='.$params['component'];
|
|
$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 file download url
|
|
*
|
|
* @param bool $forcedownload whether or not force download
|
|
* @param bool $https whether or not force https
|
|
* @return string url
|
|
*/
|
|
public function get_url($forcedownload=false, $https=false) {
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Whether or not I can read content of this file or enter directory
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_readable() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Whether or not new files or directories can be added
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_writable() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Is this info area and is it "empty"? Are there any files in subfolders?
|
|
*
|
|
* This is used mostly in repositories to reduce the
|
|
* number of empty folders. This method may be very slow,
|
|
* use with care.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_empty_area() {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* 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;
|
|
}
|
|
|
|
/**
|
|
* Returns the license type of the file
|
|
* @return string license short name or null
|
|
*/
|
|
public function get_license() {
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Returns the author name of the file
|
|
*
|
|
* @return string author name or null
|
|
*/
|
|
public function get_author() {
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Returns the source of the file
|
|
*
|
|
* @return string a source url or null
|
|
*/
|
|
public function get_source() {
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Returns the sort order of the file
|
|
*
|
|
* @return int
|
|
*/
|
|
public function get_sortorder() {
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* Create new directory, may throw exception - make sure
|
|
* params are valid.
|
|
*
|
|
* @param string $newdirname name of new directory
|
|
* @param int $userid 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 $userid 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 $userid 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 int|stored_file $fid id or stored_file of file
|
|
* @param int $userid 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 context ID
|
|
* @param string $component component
|
|
* @param string $filearea file area
|
|
* @param int $itemid item ID
|
|
* @param string $filepath file path
|
|
* @param string $filename file name
|
|
* @return boolean success
|
|
*/
|
|
public function copy_to_storage($contextid, $component, $filearea, $itemid, $filepath, $filename) {
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Copy content of this file to local storage, overriding current file if needed.
|
|
*
|
|
* @todo MDL-31068 implement move() rename() unzip() zip()
|
|
* @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);
|
|
}
|