From aedb03962c4acbb74d0009c4a39315caabf75952 Mon Sep 17 00:00:00 2001 From: Dongsheng Cai Date: Fri, 4 Dec 2009 09:19:54 +0000 Subject: [PATCH] "MDL-15351, added phpdocs" --- repository/local/repository.class.php | 48 ++++++++++++++++++++------- 1 file changed, 36 insertions(+), 12 deletions(-) diff --git a/repository/local/repository.class.php b/repository/local/repository.class.php index 866d4b83c8..d144269cdc 100755 --- a/repository/local/repository.class.php +++ b/repository/local/repository.class.php @@ -1,14 +1,30 @@ . /** + * repository_local class is used to browse moodle files * + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ + class repository_local extends repository { /** @@ -39,6 +55,7 @@ class repository_local extends repository { } /** + * Get file listing * * @param string $encodedpath * @param string $path not used by this plugin @@ -117,16 +134,15 @@ class repository_local extends repository { } /** - * Download a file, this function can be overridden by - * subclass. + * Move a file to draft area * - * @global object $CFG + * @global object $USER + * @global object $DB * @param string $encoded The metainfo of file, it is base64 encoded php seriablized data * @param string $title The intended name of file * @param string $itemid itemid * @param string $save_path the new path in draft area - * @return array The metainfo of file - * @see curl package + * @return array The information of file */ public function move_to_draft($encoded, $title = '', $itemid = '', $save_path = '/') { global $USER, $DB; @@ -153,11 +169,19 @@ class repository_local extends repository { } /** - * @return string + * Set repository name + * + * @return string repository name */ public function get_name(){ return get_string('repositoryname', 'repository_local');; } + + /** + * Local file don't support to link to external links + * + * @return int + */ public function supported_returntypes() { return FILE_INTERNAL; } -- 2.39.5