From 5d354ded1a3ea10fec211a6a65ac705d331a9b42 Mon Sep 17 00:00:00 2001 From: Petr Skoda Date: Mon, 6 Sep 2010 11:17:43 +0000 Subject: [PATCH] standardized PHPDocs package info --- admin/roles/admins.php | 2 +- admin/roles/allow.php | 2 +- admin/roles/assign.php | 2 +- admin/roles/check.php | 2 +- admin/roles/define.php | 2 +- admin/roles/lib.php | 2 +- admin/roles/manage.php | 2 +- admin/roles/managetabs.php | 2 +- admin/roles/override.php | 2 +- admin/roles/permissions.php | 2 +- admin/roles/permissions_forms.php | 2 +- admin/roles/usersroles.php | 2 +- rating/index.php | 9 +++++---- rating/lib.php | 11 ++++++----- rating/rate.php | 7 ++++--- rating/rate_ajax.php | 11 ++++++----- repository/draftfiles_manager.php | 6 +++--- repository/filepicker.php | 6 +++--- repository/lib.php | 6 +++--- repository/manage_instances.php | 6 +++--- repository/repository_ajax.php | 6 +++--- repository/repository_callback.php | 6 +++--- 22 files changed, 51 insertions(+), 47 deletions(-) diff --git a/admin/roles/admins.php b/admin/roles/admins.php index 065e29a0b22..450d432028e 100644 --- a/admin/roles/admins.php +++ b/admin/roles/admins.php @@ -18,7 +18,7 @@ /** * Lets you site administrators * - * @package moodlecore + * @package core * @subpackage role * @copyright 2010 Petr Skoda (skodak) http://skodak.org * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/admin/roles/allow.php b/admin/roles/allow.php index 4ecd8473255..52078e7f181 100755 --- a/admin/roles/allow.php +++ b/admin/roles/allow.php @@ -18,7 +18,7 @@ /** * Allow overriding of roles by other roles * - * @package moodlecore + * @package core * @subpackage role * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/admin/roles/assign.php b/admin/roles/assign.php index d19d6901a70..6922350b178 100755 --- a/admin/roles/assign.php +++ b/admin/roles/assign.php @@ -18,7 +18,7 @@ /** * Lets you assign roles to users in a particular context. * - * @package moodlecore + * @package core * @subpackage role * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/admin/roles/check.php b/admin/roles/check.php index ee29a96ba3e..1f6f6acf499 100755 --- a/admin/roles/check.php +++ b/admin/roles/check.php @@ -18,7 +18,7 @@ /** * Shows the result of has_capability for every capability for a user in a context. * - * @package moodlecore + * @package core * @subpackage role * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/admin/roles/define.php b/admin/roles/define.php index 1da439c1beb..d2f4eb5f501 100755 --- a/admin/roles/define.php +++ b/admin/roles/define.php @@ -24,7 +24,7 @@ * edit - edit the definition of a role * view - view the definition of a role * - * @package moodlecore + * @package core * @subpackage role * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/admin/roles/lib.php b/admin/roles/lib.php index 9b0b964e2d7..68ece465e29 100644 --- a/admin/roles/lib.php +++ b/admin/roles/lib.php @@ -24,7 +24,7 @@ * edit - edit the definition of a role * view - view the definition of a role * - * @package moodlecore + * @package core * @subpackage role * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/admin/roles/manage.php b/admin/roles/manage.php index f9b09355375..0c5aa8f919b 100755 --- a/admin/roles/manage.php +++ b/admin/roles/manage.php @@ -28,7 +28,7 @@ * For all but the first two of those, you also need a roleid parameter, and * possibly some other data. * - * @package moodlecore + * @package core * @subpackage role * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/admin/roles/managetabs.php b/admin/roles/managetabs.php index 8960b80d523..4a7dd95c4e3 100755 --- a/admin/roles/managetabs.php +++ b/admin/roles/managetabs.php @@ -18,7 +18,7 @@ /** * Defines the tab bar used on the manage/allow assign/allow overrides pages. * - * @package moodlecore + * @package core * @subpackage role * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/admin/roles/override.php b/admin/roles/override.php index 9e395c5bb8c..de7e45d42ca 100755 --- a/admin/roles/override.php +++ b/admin/roles/override.php @@ -18,7 +18,7 @@ /** * Lets you override role definitions in contexts. * - * @package moodlecore + * @package core * @subpackage role * @copyright 1999 onwards Martin Dougiamas (http://dougiamas.com) * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/admin/roles/permissions.php b/admin/roles/permissions.php index d62c544c69c..d1d34f20258 100644 --- a/admin/roles/permissions.php +++ b/admin/roles/permissions.php @@ -18,7 +18,7 @@ /** * This script serves draft files of current user * - * @package moodlecore + * @package core * @subpackage role * @copyright 2009 Petr Skoda (skodak) info@skodak.org * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/admin/roles/permissions_forms.php b/admin/roles/permissions_forms.php index d3c631d6fc1..32b646ef66a 100644 --- a/admin/roles/permissions_forms.php +++ b/admin/roles/permissions_forms.php @@ -18,7 +18,7 @@ /** * This script serves draft files of current user * - * @package moodlecore + * @package core * @subpackage role * @copyright 2009 Petr Skoda (skodak) info@skodak.org * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later diff --git a/admin/roles/usersroles.php b/admin/roles/usersroles.php index 6fca192536c..a6e5da071cc 100644 --- a/admin/roles/usersroles.php +++ b/admin/roles/usersroles.php @@ -19,7 +19,7 @@ * User roles report list all the users who have been assigned a particular * role in all contexts. * - * @package moodlecore + * @package core * @subpackage role * @copyright © 2007 The Open University and others * @author t.j.hunt@open.ac.uk and others diff --git a/rating/index.php b/rating/index.php index 68c1e69b17c..a06b9d86c67 100644 --- a/rating/index.php +++ b/rating/index.php @@ -18,9 +18,10 @@ /** * A page to display a list of ratings for a given item (forum post etc) * - * @package moodlecore - * @copyright 2010 Andrew Davis - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package core + * @subpackage rating + * @copyright 2010 Andrew Davis + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once("../config.php"); @@ -97,7 +98,7 @@ if (!$ratings) { //we could clone the rating object or preserve the rating id if we needed it again //but we don't $rating->id = $rating->uid; - + echo ''; echo ""; if($course && $course->id) { diff --git a/rating/lib.php b/rating/lib.php index 60da7d7d62f..a7bb8ee9b7a 100644 --- a/rating/lib.php +++ b/rating/lib.php @@ -18,9 +18,10 @@ /** * A class representing a single rating and containing some static methods for manipulating ratings * - * @package moodlecore - * @copyright 2010 Andrew Davis - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package core + * @subpackage rating + * @copyright 2010 Andrew Davis + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ define('RATING_UNSET_RATING', -999); @@ -386,7 +387,7 @@ class rating_manager { $rating->count = $rec->numratings; //unset($rec->numratings); $rating->rating = $rec->usersrating; //unset($rec->usersrating); $rating->itemtimecreated = $this->get_item_time_created($item); - + break; } } @@ -492,7 +493,7 @@ class rating_manager { $params['contextid']= $contextid; $itemtable = $options->itemtable; $itemtableusercolumn= $options->itemtableusercolumn; - $scaleid = $options->scaleid; + $scaleid = $options->scaleid; $aggregationstring = $this->get_aggregation_method($options->aggregationmethod); //if userid is not 0 we only want the grade for a single user diff --git a/rating/rate.php b/rating/rate.php index 52b3f144c55..3ac00e8915e 100644 --- a/rating/rate.php +++ b/rating/rate.php @@ -20,9 +20,10 @@ * * It is similar to rate_ajax.php. Unlike rate_ajax.php a return url is required. * - * @package moodlecore - * @copyright 2010 Andrew Davis - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package core + * @subpackage rating + * @copyright 2010 Andrew Davis + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once('../config.php'); diff --git a/rating/rate_ajax.php b/rating/rate_ajax.php index 0b51c8c03c0..fb6c19932e2 100644 --- a/rating/rate_ajax.php +++ b/rating/rate_ajax.php @@ -20,9 +20,10 @@ * * It is similar to rate.php. Unlike rate.php a return url is NOT required. * - * @package moodlecore - * @copyright 2010 Andrew Davis - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @package core + * @subpackage rating + * @copyright 2010 Andrew Davis + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ define('AJAX_SCRIPT', true); @@ -99,7 +100,7 @@ if ($userrating != RATING_UNSET_RATING) { $options->contextid = $context->id; $options->userid = $USER->id; $options->itemid = $itemid; - + $rm->delete_ratings($options); } @@ -156,7 +157,7 @@ if ($items[0]->rating->settings->aggregationmethod==RATING_AGGREGATE_COUNT or $i //if we accept the item owner user id from the http request a user could alter the URL and erroneously get access to the rating aggregate //if its their own item and they have view permission -if (($USER->id==$items[0]->rating->itemuserid && has_capability('moodle/rating:view',$context) +if (($USER->id==$items[0]->rating->itemuserid && has_capability('moodle/rating:view',$context) && (empty($pluginpermissionsarray) or $pluginpermissionsarray['view'])) //or if its not their item or if no user created the item (the hub did) and they have viewany permission || (($USER->id!=$items[0]->rating->itemuserid or empty($items[0]->rating->itemuserid)) && has_capability('moodle/rating:viewany',$context) diff --git a/repository/draftfiles_manager.php b/repository/draftfiles_manager.php index f4aec8c45ec..28954b904da 100755 --- a/repository/draftfiles_manager.php +++ b/repository/draftfiles_manager.php @@ -26,10 +26,10 @@ * This file is used to manage draft files in non-javascript browsers * * @since 2.0 - * @package moodlecore + * @package core * @subpackage repository - * @copyright 2010 Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @copyright 2010 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once('../config.php'); diff --git a/repository/filepicker.php b/repository/filepicker.php index fb14829da8c..77c72716399 100755 --- a/repository/filepicker.php +++ b/repository/filepicker.php @@ -20,10 +20,10 @@ * This file is used to browse repositories in non-javascript mode * * @since 2.0 - * @package moodlecore + * @package core * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @copyright 2009 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once('../config.php'); diff --git a/repository/lib.php b/repository/lib.php index 691bc3c8367..efef2fc786d 100644 --- a/repository/lib.php +++ b/repository/lib.php @@ -21,10 +21,10 @@ * and was introduced as part of the changes occuring in Moodle 2.0 * * @since 2.0 - * @package moodlecore + * @package core * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @copyright 2009 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(dirname(dirname(__FILE__)) . '/config.php'); diff --git a/repository/manage_instances.php b/repository/manage_instances.php index 5478dd67e0e..5b5d1c897e8 100644 --- a/repository/manage_instances.php +++ b/repository/manage_instances.php @@ -20,10 +20,10 @@ * This file is used to manage repositories * * @since 2.0 - * @package moodlecore + * @package core * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @copyright 2009 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(dirname(dirname(__FILE__)) . '/config.php'); diff --git a/repository/repository_ajax.php b/repository/repository_ajax.php index 7939679722b..f726e92756b 100755 --- a/repository/repository_ajax.php +++ b/repository/repository_ajax.php @@ -20,10 +20,10 @@ * The Web service script that is called from the filepicker front end * * @since 2.0 - * @package moodlecore + * @package core * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @copyright 2009 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ define('AJAX_SCRIPT', true); diff --git a/repository/repository_callback.php b/repository/repository_callback.php index 2b7095cdfa8..3abcbca708e 100755 --- a/repository/repository_callback.php +++ b/repository/repository_callback.php @@ -20,10 +20,10 @@ * Repository instance callback script * * @since 2.0 - * @package moodlecore + * @package core * @subpackage repository - * @copyright 2009 Dongsheng Cai - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + * @copyright 2009 Dongsheng Cai + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once(dirname(dirname(__FILE__)).'/config.php');