From 10d53fd34941e6de3c849504d70e722c250a4965 Mon Sep 17 00:00:00 2001 From: Dongsheng Cai Date: Thu, 17 Dec 2009 03:40:38 +0000 Subject: [PATCH] "MDL-19235, add boilerplates to repository module files" --- repository/alfresco/repository.class.php | 23 +++++++++- repository/alfresco/version.php | 16 +++++++ repository/boxnet/repository.class.php | 24 +++++++++- repository/boxnet/version.php | 16 +++++++ repository/filesystem/repository.class.php | 21 ++++++++- repository/filesystem/version.php | 16 +++++++ repository/flickr/repository.class.php | 22 ++++++++- repository/flickr/version.php | 16 +++++++ repository/flickr_public/image.php | 22 +++++++++ repository/flickr_public/repository.class.php | 22 ++++++++- repository/flickr_public/version.php | 16 +++++++ repository/googledocs/repository.class.php | 23 +++++++++- repository/googledocs/version.php | 16 +++++++ repository/local/repository.class.php | 3 +- repository/local/version.php | 16 +++++++ repository/mahara/repository.class.php | 46 +++++++++---------- repository/mahara/version.php | 16 +++++++ repository/merlot/repository.class.php | 6 ++- repository/merlot/version.php | 16 +++++++ repository/picasa/repository.class.php | 22 ++++++++- repository/picasa/version.php | 16 +++++++ repository/remotemoodle/repository.class.php | 24 +++++++++- repository/remotemoodle/version.php | 16 +++++++ repository/s3/S3.php | 1 + repository/s3/repository.class.php | 3 +- repository/s3/version.php | 16 +++++++ repository/upload/repository.class.php | 23 +++++++++- repository/upload/version.php | 16 +++++++ repository/url/lib.php | 1 + repository/url/repository.class.php | 23 +++++++++- repository/url/version.php | 16 +++++++ repository/webdav/repository.class.php | 24 +++++++++- repository/webdav/version.php | 16 +++++++ repository/wikimedia/repository.class.php | 28 +++++++++++ repository/wikimedia/version.php | 16 +++++++ repository/wikimedia/wikimedia.php | 22 +++++++++ repository/youtube/repository.class.php | 22 ++++++++- repository/youtube/version.php | 16 +++++++ 38 files changed, 634 insertions(+), 43 deletions(-) diff --git a/repository/alfresco/repository.class.php b/repository/alfresco/repository.class.php index 227dc9560b..a9d1ee96a2 100755 --- a/repository/alfresco/repository.class.php +++ b/repository/alfresco/repository.class.php @@ -1,8 +1,29 @@ . + /** * repository_alfresco class * - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_alfresco extends repository { diff --git a/repository/alfresco/version.php b/repository/alfresco/version.php index 6955b54520..2cb3a5862d 100644 --- a/repository/alfresco/version.php +++ b/repository/alfresco/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 20090080101; diff --git a/repository/boxnet/repository.class.php b/repository/boxnet/repository.class.php index 1a0e4d1106..8f4b00ef34 100755 --- a/repository/boxnet/repository.class.php +++ b/repository/boxnet/repository.class.php @@ -1,12 +1,32 @@ . + require_once($CFG->libdir.'/boxlib.php'); /** * repository_boxnet class * This is a subclass of repository class * - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_boxnet extends repository { private $box; diff --git a/repository/boxnet/version.php b/repository/boxnet/version.php index 0856417047..f4827db6aa 100755 --- a/repository/boxnet/version.php +++ b/repository/boxnet/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080104; diff --git a/repository/filesystem/repository.class.php b/repository/filesystem/repository.class.php index 9ff2ae3ef8..a8cf83d2dc 100644 --- a/repository/filesystem/repository.class.php +++ b/repository/filesystem/repository.class.php @@ -1,13 +1,32 @@ . + /** * repository_filesystem class * Create a repository from your local filesystem * *NOTE* for security issue, we use a fixed repository path * which is %moodledata%/repository * + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dongsheng Cai * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_filesystem extends repository { public function __construct($repositoryid, $context = SITEID, $options = array()) { diff --git a/repository/filesystem/version.php b/repository/filesystem/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/filesystem/version.php +++ b/repository/filesystem/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; diff --git a/repository/flickr/repository.class.php b/repository/flickr/repository.class.php index 65f61048e7..e12738c854 100755 --- a/repository/flickr/repository.class.php +++ b/repository/flickr/repository.class.php @@ -1,10 +1,30 @@ . + /** * repository_flickr class * This plugin is used to access user's private flickr repository * + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dongsheng Cai * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->libdir.'/flickrlib.php'); diff --git a/repository/flickr/version.php b/repository/flickr/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/flickr/version.php +++ b/repository/flickr/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; diff --git a/repository/flickr_public/image.php b/repository/flickr_public/image.php index dcc515936c..feb6b48a0f 100755 --- a/repository/flickr_public/image.php +++ b/repository/flickr_public/image.php @@ -1,4 +1,26 @@ . + +/** + * moodle_image class + * + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + */ class moodle_image { private $imagepath; private $info; diff --git a/repository/flickr_public/repository.class.php b/repository/flickr_public/repository.class.php index 8bb57965ca..ae16935914 100644 --- a/repository/flickr_public/repository.class.php +++ b/repository/flickr_public/repository.class.php @@ -1,12 +1,32 @@ . + /** * repository_flickr_public class * This one is used to create public repository * You can set up a public account in admin page, so everyone can * access photos in this public account * + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dongsheng Cai * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->libdir.'/flickrlib.php'); diff --git a/repository/flickr_public/version.php b/repository/flickr_public/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/flickr_public/version.php +++ b/repository/flickr_public/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; diff --git a/repository/googledocs/repository.class.php b/repository/googledocs/repository.class.php index f5973a1967..5018dff13d 100644 --- a/repository/googledocs/repository.class.php +++ b/repository/googledocs/repository.class.php @@ -1,9 +1,28 @@ . + /** * Google Docs Plugin * - * @author Dan Poltawski - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dan Poltawski + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->libdir.'/googleapi.php'); diff --git a/repository/googledocs/version.php b/repository/googledocs/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/googledocs/version.php +++ b/repository/googledocs/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; diff --git a/repository/local/repository.class.php b/repository/local/repository.class.php index d5c0dad27f..30f5311018 100755 --- a/repository/local/repository.class.php +++ b/repository/local/repository.class.php @@ -21,7 +21,8 @@ * @since 2.0 * @package moodlecore * @subpackage repository - * @copyright 2009 Dongsheng Cai + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/repository/local/version.php b/repository/local/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/local/version.php +++ b/repository/local/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; diff --git a/repository/mahara/repository.class.php b/repository/mahara/repository.class.php index c3ddeef40f..7c9359331c 100644 --- a/repository/mahara/repository.class.php +++ b/repository/mahara/repository.class.php @@ -1,35 +1,33 @@ dirroot.'/repository/lib.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 . /** * repository_mahara class * This plugin allowed to connect a retrieve a file from Mahara site * This is a subclass of repository class + * + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Jerome Mouneyrac + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ +require_once($CFG->dirroot.'/repository/lib.php'); + class repository_mahara extends repository { /** diff --git a/repository/mahara/version.php b/repository/mahara/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/mahara/version.php +++ b/repository/mahara/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; diff --git a/repository/merlot/repository.class.php b/repository/merlot/repository.class.php index d585c74c8c..9eca35a6d3 100755 --- a/repository/merlot/repository.class.php +++ b/repository/merlot/repository.class.php @@ -18,8 +18,12 @@ /** * repository_merlot is used to search merlot.org in moodle * + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dongsheng Cai * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_merlot extends repository { diff --git a/repository/merlot/version.php b/repository/merlot/version.php index d30bf2e008..c3a8ba9897 100755 --- a/repository/merlot/version.php +++ b/repository/merlot/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009111300; diff --git a/repository/picasa/repository.class.php b/repository/picasa/repository.class.php index b34b1085ec..bd6dd9e187 100644 --- a/repository/picasa/repository.class.php +++ b/repository/picasa/repository.class.php @@ -1,9 +1,29 @@ . + /** * Picasa Repository Plugin * + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dan Poltawski * @author Dan Poltawski - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->libdir.'/googleapi.php'); diff --git a/repository/picasa/version.php b/repository/picasa/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/picasa/version.php +++ b/repository/picasa/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; diff --git a/repository/remotemoodle/repository.class.php b/repository/remotemoodle/repository.class.php index b215e048a9..982a420895 100644 --- a/repository/remotemoodle/repository.class.php +++ b/repository/remotemoodle/repository.class.php @@ -1,10 +1,30 @@ . + /** * repository_remotemoodle class * This plugin allowed to connect a retrieve a file from another Moodle site * This is a subclass of repository class - * @author Jerome Mouneyrac - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Jerome Mouneyrac + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->dirroot.'/repository/lib.php'); diff --git a/repository/remotemoodle/version.php b/repository/remotemoodle/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/remotemoodle/version.php +++ b/repository/remotemoodle/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; diff --git a/repository/s3/S3.php b/repository/s3/S3.php index 603b39b301..dadfb5ab5e 100644 --- a/repository/s3/S3.php +++ b/repository/s3/S3.php @@ -1,4 +1,5 @@ + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ diff --git a/repository/s3/version.php b/repository/s3/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/s3/version.php +++ b/repository/s3/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; diff --git a/repository/upload/repository.class.php b/repository/upload/repository.class.php index 31f18ee3fc..8658577a69 100755 --- a/repository/upload/repository.class.php +++ b/repository/upload/repository.class.php @@ -1,9 +1,30 @@ . + /** * repository_upload class * A subclass of repository, which is used to upload file * - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_upload extends repository { diff --git a/repository/upload/version.php b/repository/upload/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/upload/version.php +++ b/repository/upload/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; diff --git a/repository/url/lib.php b/repository/url/lib.php index ae5d9cefab..f9c65f81c9 100644 --- a/repository/url/lib.php +++ b/repository/url/lib.php @@ -1,4 +1,5 @@ . + /** * repository_url class * A subclass of repository, which is used to download a file from a specific url * - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(dirname(__FILE__).'/lib.php'); diff --git a/repository/url/version.php b/repository/url/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/url/version.php +++ b/repository/url/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; diff --git a/repository/webdav/repository.class.php b/repository/webdav/repository.class.php index 0484729999..154bcd0354 100644 --- a/repository/webdav/repository.class.php +++ b/repository/webdav/repository.class.php @@ -1,9 +1,29 @@ . + /** * repository_webdav class * - * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->libdir.'/webdavlib.php'); diff --git a/repository/webdav/version.php b/repository/webdav/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/webdav/version.php +++ b/repository/webdav/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; diff --git a/repository/wikimedia/repository.class.php b/repository/wikimedia/repository.class.php index 833c1403e3..0069a20209 100644 --- a/repository/wikimedia/repository.class.php +++ b/repository/wikimedia/repository.class.php @@ -1,6 +1,34 @@ . + require_once('wikimedia.php'); +/** + * repository_wikimedia class + * This is a class used to browse images from wikimedia + * + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dongsheng Cai + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + class repository_wikimedia extends repository { public function __construct($repositoryid, $context = SITEID, $options = array()) { parent::__construct($repositoryid, $context, $options); diff --git a/repository/wikimedia/version.php b/repository/wikimedia/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/wikimedia/version.php +++ b/repository/wikimedia/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; diff --git a/repository/wikimedia/wikimedia.php b/repository/wikimedia/wikimedia.php index cd1c257838..d2f06a2639 100644 --- a/repository/wikimedia/wikimedia.php +++ b/repository/wikimedia/wikimedia.php @@ -1,5 +1,27 @@ . + +/** + * wikimedia class + * A class used to browse images from wikimedia + * + * @author Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + */ class wikimedia { private $_conn = null; private $_param = array(); diff --git a/repository/youtube/repository.class.php b/repository/youtube/repository.class.php index e4847960bd..bbbb055cd5 100644 --- a/repository/youtube/repository.class.php +++ b/repository/youtube/repository.class.php @@ -1,9 +1,29 @@ . + /** * repository_youtube class * + * @since 2.0 + * @package moodlecore + * @subpackage repository + * @copyright 2009 Dongsheng Cai * @author Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU Public License + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class repository_youtube extends repository { diff --git a/repository/youtube/version.php b/repository/youtube/version.php index 868025bd14..885ef3cf03 100644 --- a/repository/youtube/version.php +++ b/repository/youtube/version.php @@ -1,2 +1,18 @@ . + $plugin->version = 2009080101; -- 2.39.5