diff --git a/repository/boxnet/repository.class.php b/repository/boxnet/repository.class.php index 1d13885b52c..12e08893278 100755 --- a/repository/boxnet/repository.class.php +++ b/repository/boxnet/repository.class.php @@ -10,9 +10,19 @@ require_once($CFG->libdir.'/boxlib.php'); +/** + * + */ class repository_boxnet extends repository { private $box; + /** + * + * @global $SESSION + * @param $repositoryid + * @param $context + * @param $options + */ public function __construct($repositoryid, $context = SITEID, $options = array()) { global $SESSION; $options['username'] = optional_param('boxusername', '', PARAM_RAW); @@ -43,17 +53,32 @@ class repository_boxnet extends repository { } } + /** + * + * @global $SESSION + * @return + */ public function check_login() { global $SESSION; return !empty($SESSION->{$this->sess_name}); } + /** + * + * @global $SESSION + * @return + */ public function logout() { global $SESSION; unset($SESSION->{$this->sess_name}); return $this->print_login(); } + /** + * + * @param $options + * @return + */ public function set_option($options = array()) { if (!empty($options['api_key'])) { set_config('api_key', trim($options['api_key']), 'boxnet'); @@ -63,6 +88,11 @@ class repository_boxnet extends repository { return $ret; } + /** + * + * @param $config + * @return + */ public function get_option($config = '') { if($config==='api_key') { return trim(get_config('boxnet', 'api_key')); @@ -73,6 +103,11 @@ class repository_boxnet extends repository { return $options; } + /** + * + * @global $SESSION + * @return + */ public function global_search() { global $SESSION; if (empty($SESSION->{$this->sess_name})) { @@ -82,6 +117,11 @@ class repository_boxnet extends repository { } } + /** + * + * @global $DB + * @return + */ public function get_login() { global $DB; if ($entry = $DB->get_record('repository_instances', array('id'=>$this->id))) { @@ -93,6 +133,13 @@ class repository_boxnet extends repository { } return $ret; } + + /** + * + * @global $CFG + * @param $search_text + * @return + */ public function search($search_text) { global $CFG; $list = array(); @@ -118,6 +165,13 @@ class repository_boxnet extends repository { $ret['list'] = $list; return $ret; } + + /** + * + * @global $CFG + * @param $path + * @return + */ public function get_listing($path = '/'){ global $CFG; $list = array(); @@ -132,6 +186,10 @@ class repository_boxnet extends repository { return $ret; } + /** + * + * @return + */ public function print_login(){ $t = $this->box->getTicket(); $ret = $this->get_login(); @@ -157,10 +215,18 @@ class repository_boxnet extends repository { } } + /** + * + * @return + */ public static function get_type_option_names() { return array('api_key'); } + /** + * + * @param $ + */ public function type_config_form(&$mform) { $public_account = get_config('boxnet', 'public_account'); $api_key = get_config('boxnet', 'api_key'); @@ -173,5 +239,4 @@ class repository_boxnet extends repository { $mform->addElement('static', null, '', get_string('information','repository_boxnet')); } } - -?> +?> \ No newline at end of file diff --git a/repository/flickr/repository.class.php b/repository/flickr/repository.class.php index 4a99dc7e843..e0e04a3d234 100755 --- a/repository/flickr/repository.class.php +++ b/repository/flickr/repository.class.php @@ -10,10 +10,21 @@ require_once($CFG->libdir.'/flickrlib.php'); +/** + * + */ class repository_flickr extends repository { private $flickr; public $photos; + /** + * + * @global $SESSION + * @global $CFG + * @param $repositoryid + * @param $context + * @param $options + */ public function __construct($repositoryid, $context = SITEID, $options = array()) { global $SESSION, $CFG; $options['page'] = optional_param('p', 1, PARAM_INT); @@ -39,9 +50,19 @@ class repository_flickr extends repository { } } + + /** + * + * @return + */ public function check_login() { return !empty($this->token); } + + /** + * + * @return + */ public function logout() { set_user_preference($this->setting, ''); set_user_preference($this->setting.'_nsid', ''); @@ -49,6 +70,12 @@ class repository_flickr extends repository { $this->nsid = ''; return $this->print_login(); } + + /** + * + * @param $options + * @return + */ public function set_option($options = array()) { if (!empty($options['api_key'])) { set_config('api_key', trim($options['api_key']), 'flickr'); @@ -62,6 +89,11 @@ class repository_flickr extends repository { return $ret; } + /** + * + * @param $config + * @return + */ public function get_option($config = '') { if ($config==='api_key') { return trim(get_config('flickr', 'api_key')); @@ -75,6 +107,10 @@ class repository_flickr extends repository { return $options; } + /** + * + * @return + */ public function global_search() { if (empty($this->token)) { return false; @@ -82,6 +118,12 @@ class repository_flickr extends repository { return true; } } + + /** + * + * @param $ajax + * @return + */ public function print_login($ajax = true) { if ($ajax) { $ret = array(); @@ -92,6 +134,13 @@ class repository_flickr extends repository { return $ret; } } + + /** + * + * @param $photos + * @param $path + * @return + */ private function build_list($photos, $path = 1) { $photos_url = $this->flickr->urls_getUserPhotos($this->nsid); $ret = array(); @@ -120,6 +169,12 @@ class repository_flickr extends repository { } return $ret; } + + /** + * + * @param $search_text + * @return + */ public function search($search_text) { $photos = $this->flickr->photos_search(array( 'user_id'=>$this->nsid, @@ -129,6 +184,12 @@ class repository_flickr extends repository { )); return $this->build_list($photos); } + + /** + * + * @param $path + * @return + */ public function get_listing($path = '1') { $photos_url = $this->flickr->urls_getUserPhotos($this->nsid); @@ -140,9 +201,22 @@ class repository_flickr extends repository { )); return $this->build_list($photos, $path); } + + /** + * + * @return + */ public function print_listing() { return false; } + + /** + * + * @global $CFG + * @param $photo_id + * @param $file + * @return + */ public function get_file($photo_id, $file = '') { global $CFG; $result = $this->flickr->photos_getSizes($photo_id); @@ -175,6 +249,11 @@ class repository_flickr extends repository { return $dir.$file; } + /** + * + * @global $CFG + * @param $ + */ public function type_config_form(&$mform) { global $CFG; $api_key = get_config('flickr', 'api_key'); @@ -206,8 +285,11 @@ class repository_flickr extends repository { $mform->addRule('secret', $strrequired, 'required', null, 'client'); } + /** + * + * @return + */ public static function get_type_option_names() { return array('api_key', 'secret'); } - -} +} \ No newline at end of file diff --git a/repository/flickr_public/repository.class.php b/repository/flickr_public/repository.class.php index 735f4677cf9..510946f5e18 100644 --- a/repository/flickr_public/repository.class.php +++ b/repository/flickr_public/repository.class.php @@ -12,10 +12,18 @@ require_once($CFG->libdir.'/flickrlib.php'); +/** + * + */ class repository_flickr_public extends repository { private $flickr; public $photos; + /** + * + * @param $options + * @return + */ public function set_option($options = array()) { if (!empty($options['api_key'])) { set_config('api_key', trim($options['api_key']), 'flickr_public'); @@ -25,6 +33,11 @@ class repository_flickr_public extends repository { return $ret; } + /** + * + * @param $config + * @return + */ public function get_option($config = '') { if ($config==='api_key') { return trim(get_config('flickr_public', 'api_key')); @@ -35,6 +48,10 @@ class repository_flickr_public extends repository { return $options; } + /** + * + * @return + */ public function global_search() { if (empty($this->flickr_account)) { return false; @@ -43,6 +60,14 @@ class repository_flickr_public extends repository { } } + /** + * + * @global $CFG + * @param $repositoryid + * @param $context + * @param $options + * @param $readonly + */ public function __construct($repositoryid, $context = SITEID, $options = array(), $readonly=0) { global $CFG; $options['page'] = optional_param('p', 1, PARAM_INT); @@ -63,9 +88,20 @@ class repository_flickr_public extends repository { } } } + + /** + * + * @return + */ public function check_login() { return !empty($this->flickr_account); } + + /** + * + * @param $ajax + * @return + */ public function print_login($ajax = true) { if ($ajax) { $ret = array(); @@ -77,6 +113,12 @@ class repository_flickr_public extends repository { return $ret; } } + + /** + * + * @param $search_text + * @return + */ public function search($search_text) { $people = $this->flickr->people_findByEmail($this->flickr_account); $this->nsid = $people['nsid']; @@ -92,6 +134,12 @@ class repository_flickr_public extends repository { } return $this->build_list($photos); } + + /** + * + * @param $path + * @return + */ public function get_listing($path = '1') { $people = $this->flickr->people_findByEmail($this->flickr_account); $this->nsid = $people['nsid']; @@ -99,6 +147,13 @@ class repository_flickr_public extends repository { return $this->build_list($photos, $path); } + + /** + * + * @param $photos + * @param $path + * @return + */ private function build_list($photos, $path = 1) { $photos_url = $this->flickr->urls_getUserPhotos($this->nsid); $ret = array(); @@ -128,16 +183,31 @@ class repository_flickr_public extends repository { return $ret; } + /** + * + * @return + */ public function print_listing() { return false; } + /** + * + * @return + */ public function print_search() { parent::print_search(); echo '

'; return true; } + /** + * + * @global $CFG + * @param $photo_id + * @param $file + * @return + */ public function get_file($photo_id, $file = '') { global $CFG; $result = $this->flickr->photos_getSizes($photo_id); @@ -169,15 +239,27 @@ class repository_flickr_public extends repository { return $dir.$file; } + /** + * + * @param $ + */ public function instance_config_form(&$mform) { $mform->addElement('text', 'email_address', get_string('emailaddress', 'repository_flickr_public')); $mform->addRule('email_address', get_string('required'), 'required', null, 'client'); } + /** + * + * @return + */ public static function get_instance_option_names() { return array('email_address'); } + /** + * + * @param $ + */ public function type_config_form(&$mform) { $api_key = get_config('flickr_public', 'api_key'); if (empty($api_key)) { @@ -189,11 +271,17 @@ class repository_flickr_public extends repository { $mform->addElement('static', null, '', get_string('information','repository_flickr_public')); } + /** + * + * @return + */ public static function get_type_option_names() { return array('api_key'); } - + /** + * + */ public static function plugin_init() { //here we create a default instance for this type repository_static_function('flickr_public','create', 'flickr_public', 0, get_system_context(), array('name' => 'default instance','email_address' => null),1); diff --git a/repository/local/repository.class.php b/repository/local/repository.class.php index 0a82b27de9e..dfe599bd827 100755 --- a/repository/local/repository.class.php +++ b/repository/local/repository.class.php @@ -7,8 +7,20 @@ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ +/** + * + */ class repository_local extends repository { + /** + * + * @global $SESSION + * @global $action + * @global $CFG + * @param $repositoryid + * @param $context + * @param $options + */ public function __construct($repositoryid, $context = SITEID, $options = array()) { global $SESSION, $action, $CFG; parent::__construct($repositoryid, $context, $options); @@ -19,6 +31,12 @@ class repository_local extends repository { // You can use $_FILES to find that file } + /** + * + * @global $SESSION + * @param $ajax + * @return + */ public function print_login($ajax = true) { global $SESSION; // TODO @@ -26,10 +44,22 @@ class repository_local extends repository { return $this->get_listing(); } + /** + * + * @param $filearea + * @param $path + * @param $visiblename + * @return + */ private function _encode_path($filearea, $path, $visiblename) { return array('path'=>serialize(array($filearea, $path)), 'name'=>$visiblename); } + /** + * + * @param $path + * @return + */ private function _decode_path($path) { $filearea = ''; $path = ''; @@ -40,10 +70,22 @@ class repository_local extends repository { return array('filearea' => $filearea, 'path' => $path); } + /** + * + * @param $search_text + * @return + */ public function search($search_text) { return $this->get_listing('', $search_text); } + /** + * + * @global $CFG + * @param $encodedpath + * @param $search + * @return + */ public function get_listing($encodedpath = '', $search = '') { global $CFG; $ret = array(); @@ -180,12 +222,19 @@ class repository_local extends repository { return $filecount; } + /** + * + */ public function print_listing() { // will be used in non-javascript file picker } - + + /** + * + * @return + */ public function get_name(){ return get_string('repositoryname', 'repository_local');; } } -?> +?> \ No newline at end of file diff --git a/repository/upload/repository.class.php b/repository/upload/repository.class.php index 1ea7aa27675..31e50e5496a 100755 --- a/repository/upload/repository.class.php +++ b/repository/upload/repository.class.php @@ -7,8 +7,20 @@ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License */ +/** + * + */ class repository_upload extends repository { + /** + * + * @global $SESSION + * @global $action + * @global $CFG + * @param $repositoryid + * @param $context + * @param $options + */ public function __construct($repositoryid, $context = SITEID, $options = array()){ global $SESSION, $action, $CFG; parent::__construct($repositoryid, $context, $options); @@ -18,11 +30,25 @@ class repository_upload extends repository { } } + /** + * + * @global $SESSION + * @param $ajax + * @return + */ public function print_login($ajax = true) { global $SESSION; return $this->get_listing(); } + /** + * + * @global $CFG + * @global $action + * @param $path + * @param $search + * @return + */ public function get_listing($path='', $search='') { global $CFG, $action; if($action=='upload'){ @@ -40,13 +66,24 @@ class repository_upload extends repository { } } + /** + * + */ public function print_listing() { } + /** + * + * @return + */ public function print_search() { return true; } + /** + * + * @return + */ public function get_name(){ return get_string('repositoryname', 'repository_upload');; }