Merge branch 'install_master' of git://github.com/amosbot/moodle
authorEloy Lafuente (stronk7) <stronk7@moodle.org>
Thu, 1 Mar 2012 10:25:29 +0000 (11:25 +0100)
committerEloy Lafuente (stronk7) <stronk7@moodle.org>
Thu, 1 Mar 2012 10:25:29 +0000 (11:25 +0100)
367 files changed:
admin/tool/customlang/db/access.php
admin/tool/unittest/db/access.php
backup/moodle2/backup_activity_task.class.php
backup/moodle2/backup_block_task.class.php
backup/moodle2/backup_course_task.class.php
backup/moodle2/backup_coursereport_plugin.class.php
backup/moodle2/backup_custom_fields.php
backup/moodle2/backup_default_block_task.class.php
backup/moodle2/backup_final_task.class.php
backup/moodle2/backup_format_plugin.class.php
backup/moodle2/backup_gradingform_plugin.class.php
backup/moodle2/backup_plagiarism_plugin.class.php
backup/moodle2/backup_plan_builder.class.php
backup/moodle2/backup_plugin.class.php
backup/moodle2/backup_qtype_plugin.class.php
backup/moodle2/backup_report_plugin.class.php
backup/moodle2/backup_root_task.class.php
backup/moodle2/backup_section_task.class.php
backup/moodle2/backup_settingslib.php
backup/moodle2/backup_stepslib.php
backup/moodle2/backup_subplugin.class.php
backup/moodle2/backup_theme_plugin.class.php
backup/moodle2/backup_xml_transformer.class.php
backup/moodle2/restore_activity_task.class.php
backup/moodle2/restore_block_task.class.php
backup/moodle2/restore_course_task.class.php
backup/moodle2/restore_coursereport_plugin.class.php
backup/moodle2/restore_default_block_task.class.php
backup/moodle2/restore_final_task.class.php
backup/moodle2/restore_format_plugin.class.php
backup/moodle2/restore_gradingform_plugin.class.php
backup/moodle2/restore_plagiarism_plugin.class.php
backup/moodle2/restore_plan_builder.class.php
backup/moodle2/restore_plugin.class.php
backup/moodle2/restore_qtype_plugin.class.php
backup/moodle2/restore_report_plugin.class.php
backup/moodle2/restore_root_task.class.php
backup/moodle2/restore_section_task.class.php
backup/moodle2/restore_settingslib.php
backup/moodle2/restore_stepslib.php
backup/moodle2/restore_subplugin.class.php
backup/moodle2/restore_theme_plugin.class.php
backup/util/settings/backup_setting.class.php
backup/util/settings/base_setting.class.php
backup/util/settings/root/root_backup_setting.class.php
blocks/community/communitycourse.php
blocks/community/locallib.php
blocks/community/renderer.php
blocks/community/yui/imagegallery/imagegallery.js
blocks/completionstatus/block_completionstatus.php
blocks/completionstatus/lang/en/block_completionstatus.php
blocks/course_list/block_course_list.php
blocks/course_list/lang/en/block_course_list.php
blocks/dock.js
blocks/html/lib.php
blocks/navigation/block_navigation.php
blocks/navigation/edit_form.php
blocks/navigation/renderer.php
blocks/navigation/version.php
blocks/online_users/db/access.php
blocks/participants/block_participants.php
blocks/private_files/block_private_files.php
blocks/private_files/lang/en/block_private_files.php
blocks/rss_client/block_rss_client.php
blocks/rss_client/db/access.php
blocks/rss_client/editfeed.php
blocks/rss_client/lang/en/block_rss_client.php
blocks/rss_client/managefeeds.php
blocks/rss_client/viewfeed.php
blocks/section_links/config_instance.html
blocks/selfcompletion/block_selfcompletion.php
blocks/selfcompletion/lang/en/block_selfcompletion.php
calendar/delete.php
calendar/event.php
calendar/lib.php
course/completion.php
course/info.php
course/publish/forms.php
course/publish/index.php
course/publish/lib.php
course/publish/metadata.php
course/publish/renderer.php
enrol/authorize/db/access.php
enrol/category/db/access.php
enrol/category/db/events.php
enrol/cohort/ajax.php
enrol/cohort/db/access.php
enrol/cohort/db/events.php
enrol/guest/db/access.php
enrol/ldap/db/access.php
enrol/locallib.php
enrol/manual/db/access.php
enrol/meta/db/access.php
enrol/meta/db/events.php
enrol/paypal/db/access.php
enrol/self/db/access.php
filter/algebra/AlgParser.pm
grade/edit/scale/edit_form.php
grade/export/ods/db/access.php
grade/export/txt/db/access.php
grade/export/xls/db/access.php
grade/export/xml/db/access.php
grade/import/csv/db/access.php
grade/import/xml/db/access.php
grade/report/grader/db/access.php
grade/report/outcomes/db/access.php
grade/report/overview/db/access.php
grade/report/overview/renderer.php
grade/report/user/db/access.php
lang/en/auth.php
lang/en/question.php
lib/accesslib.php
lib/db/access.php
lib/db/events.php
lib/dml/oci_native_moodle_database.php
lib/eventslib.php
lib/filebrowser/file_browser.php
lib/filebrowser/file_info.php
lib/filebrowser/file_info_context_course.php
lib/filebrowser/file_info_context_coursecat.php
lib/filebrowser/file_info_context_module.php
lib/filebrowser/file_info_context_system.php
lib/filebrowser/file_info_context_user.php
lib/filebrowser/file_info_stored.php
lib/filebrowser/virtual_root_file.php
lib/filelib.php
lib/filestorage/file_archive.php
lib/filestorage/file_exceptions.php
lib/filestorage/file_packer.php
lib/filestorage/file_storage.php
lib/filestorage/stored_file.php
lib/filestorage/zip_archive.php
lib/filestorage/zip_packer.php
lib/form/filemanager.php
lib/grade/constants.php
lib/html2text.php
lib/moodlelib.php
lib/navigationlib.php
lib/questionlib.php
lib/setuplib.php
lib/simpletest/testweblib.php
lib/weblib.php
login/index_form.html
mod/assignment/backup/moodle2/backup_assignment_activity_task.class.php
mod/assignment/db/access.php
mod/assignment/db/events.php
mod/assignment/lib.php
mod/chat/backup/moodle2/backup_chat_activity_task.class.php
mod/chat/db/access.php
mod/chat/db/events.php
mod/choice/backup/moodle2/backup_choice_activity_task.class.php
mod/choice/db/access.php
mod/data/backup/moodle2/backup_data_activity_task.class.php
mod/data/db/access.php
mod/data/lib.php
mod/feedback/backup/moodle2/backup_feedback_activity_task.class.php
mod/feedback/db/access.php
mod/feedback/lib.php
mod/folder/backup/moodle2/backup_folder_activity_task.class.php
mod/folder/db/access.php
mod/folder/lib.php
mod/forum/backup/moodle2/backup_forum_activity_task.class.php
mod/forum/db/access.php
mod/forum/db/events.php
mod/forum/lib.php
mod/glossary/backup/moodle2/backup_glossary_activity_task.class.php
mod/glossary/db/access.php
mod/glossary/lib.php
mod/imscp/backup/moodle2/backup_imscp_activity_task.class.php
mod/imscp/db/access.php
mod/imscp/lib.php
mod/label/backup/moodle2/backup_label_activity_task.class.php
mod/lesson/backup/moodle2/backup_lesson_activity_task.class.php
mod/lesson/db/access.php
mod/lesson/lib.php
mod/lesson/pagetypes/multichoice.php
mod/lesson/styles.css
mod/lti/backup/moodle2/backup_lti_activity_task.class.php
mod/lti/db/access.php
mod/page/backup/moodle1/lib.php
mod/page/backup/moodle2/backup_page_activity_task.class.php
mod/page/db/access.php
mod/page/lib.php
mod/quiz/backup/moodle2/backup_quiz_activity_task.class.php
mod/quiz/db/access.php
mod/quiz/db/events.php
mod/quiz/lib.php
mod/quiz/report/grading/db/access.php
mod/quiz/report/statistics/db/access.php
mod/quiz/report/statistics/lib.php
mod/resource/backup/moodle2/backup_resource_activity_task.class.php
mod/resource/db/access.php
mod/resource/lib.php
mod/scorm/backup/moodle2/backup_scorm_activity_task.class.php
mod/scorm/db/access.php
mod/scorm/lib.php
mod/survey/backup/moodle2/backup_survey_activity_task.class.php
mod/survey/db/access.php
mod/url/backup/moodle2/backup_url_activity_task.class.php
mod/url/db/access.php
mod/wiki/backup/moodle2/backup_wiki_activity_task.class.php
mod/wiki/db/access.php
mod/wiki/lib.php
mod/wiki/locallib.php
mod/workshop/backup/moodle2/backup_workshop_activity_task.class.php
mod/workshop/backup/moodle2/backup_workshop_settingslib.php
mod/workshop/backup/moodle2/backup_workshop_stepslib.php
mod/workshop/db/access.php
mod/workshop/form/accumulative/assessment_form.php
mod/workshop/form/accumulative/backup/moodle1/lib.php
mod/workshop/form/accumulative/backup/moodle2/backup_workshopform_accumulative_subplugin.class.php
mod/workshop/form/accumulative/backup/moodle2/restore_workshopform_accumulative_subplugin.class.php
mod/workshop/form/accumulative/db/install.php
mod/workshop/form/accumulative/db/upgrade.php
mod/workshop/form/accumulative/edit_form.php
mod/workshop/form/accumulative/lang/en/workshopform_accumulative.php
mod/workshop/form/accumulative/lib.php
mod/workshop/form/accumulative/simpletest/testlib.php
mod/workshop/form/accumulative/version.php
mod/workshop/form/comments/assessment_form.php
mod/workshop/form/comments/backup/moodle1/lib.php
mod/workshop/form/comments/backup/moodle2/backup_workshopform_comments_subplugin.class.php
mod/workshop/form/comments/backup/moodle2/restore_workshopform_comments_subplugin.class.php
mod/workshop/form/comments/db/install.php
mod/workshop/form/comments/db/upgrade.php
mod/workshop/form/comments/edit_form.php
mod/workshop/form/comments/lang/en/workshopform_comments.php
mod/workshop/form/comments/lib.php
mod/workshop/form/comments/version.php
mod/workshop/form/numerrors/assessment_form.php
mod/workshop/form/numerrors/backup/moodle1/lib.php
mod/workshop/form/numerrors/backup/moodle2/backup_workshopform_numerrors_subplugin.class.php
mod/workshop/form/numerrors/backup/moodle2/restore_workshopform_numerrors_subplugin.class.php
mod/workshop/form/numerrors/db/install.php
mod/workshop/form/numerrors/db/upgrade.php
mod/workshop/form/numerrors/edit_form.php
mod/workshop/form/numerrors/lang/en/workshopform_numerrors.php
mod/workshop/form/numerrors/lib.php
mod/workshop/form/numerrors/settings.php
mod/workshop/form/numerrors/simpletest/testlib.php
mod/workshop/form/numerrors/version.php
mod/workshop/form/rubric/assessment_form.php
mod/workshop/form/rubric/backup/moodle1/lib.php
mod/workshop/form/rubric/backup/moodle2/backup_workshopform_rubric_subplugin.class.php
mod/workshop/form/rubric/backup/moodle2/restore_workshopform_rubric_subplugin.class.php
mod/workshop/form/rubric/db/install.php
mod/workshop/form/rubric/db/upgrade.php
mod/workshop/form/rubric/edit_form.php
mod/workshop/form/rubric/lang/en/workshopform_rubric.php
mod/workshop/form/rubric/lib.php
mod/workshop/form/rubric/simpletest/testlib.php
mod/workshop/form/rubric/version.php
mod/workshop/lib.php
portfolio/googledocs/db/events.php
portfolio/picasa/db/events.php
question/previewlib.php
question/type/calculated/lib.php
question/type/calculated/questiontype.php
question/type/calculatedmulti/lib.php
question/type/calculatedmulti/questiontype.php
question/type/calculatedsimple/lib.php
question/type/edit_question_form.php
question/type/essay/lib.php
question/type/match/lib.php
question/type/match/questiontype.php
question/type/multianswer/questiontype.php
question/type/multichoice/lib.php
question/type/multichoice/questiontype.php
question/type/numerical/lib.php
question/type/numerical/questiontype.php
question/type/questiontypebase.php
question/type/shortanswer/lib.php
question/type/shortanswer/questiontype.php
question/type/truefalse/lib.php
report/completion/db/access.php
report/courseoverview/db/access.php
report/log/db/access.php
report/loglive/db/access.php
report/outline/db/access.php
report/participation/db/access.php
report/progress/db/access.php
report/questioninstances/db/access.php
report/security/db/access.php
report/stats/db/access.php
repository/alfresco/db/access.php
repository/boxnet/db/access.php
repository/coursefiles/db/access.php
repository/dropbox/db/access.php
repository/filesystem/db/access.php
repository/flickr/db/access.php
repository/flickr_public/db/access.php
repository/googledocs/db/access.php
repository/local/db/access.php
repository/merlot/db/access.php
repository/picasa/db/access.php
repository/recent/db/access.php
repository/s3/db/access.php
repository/upload/db/access.php
repository/url/db/access.php
repository/user/db/access.php
repository/webdav/db/access.php
repository/wikimedia/db/access.php
repository/youtube/db/access.php
theme/afterburner/style/afterburner_layout.css
theme/afterburner/style/afterburner_styles.css
theme/anomaly/style/base.css
theme/anomaly/style/general.css
theme/base/style/core.css
theme/base/style/message.css
theme/formal_white/style/core.css
theme/splash/config.php
theme/splash/lang/en/theme_splash.php
theme/splash/layout/embedded.php [new file with mode: 0644]
theme/splash/layout/general.php
theme/splash/layout/report.php
theme/splash/lib.php
theme/splash/pix/arrow-menu.gif [new file with mode: 0644]
theme/splash/pix/blue-theme.jpg [deleted file]
theme/splash/pix/blue-theme2.jpg [deleted file]
theme/splash/pix/blue.jpg [deleted file]
theme/splash/pix/contentbg.jpg [deleted file]
theme/splash/pix/contentbgright.jpg [deleted file]
theme/splash/pix/csmenubg.jpg [deleted file]
theme/splash/pix/dropdownbg.jpg [deleted file]
theme/splash/pix/green-theme.jpg [deleted file]
theme/splash/pix/green-theme2.jpg [deleted file]
theme/splash/pix/green.jpg [deleted file]
theme/splash/pix/header.jpg [deleted file]
theme/splash/pix/loginpanel.jpg [deleted file]
theme/splash/pix/logobgleft.jpg [deleted file]
theme/splash/pix/logobgleftblue.jpg [deleted file]
theme/splash/pix/logobgleftgreen.jpg [deleted file]
theme/splash/pix/logobgleftorange.jpg [deleted file]
theme/splash/pix/logobgright.jpg [deleted file]
theme/splash/pix/logobgrightblue.jpg [deleted file]
theme/splash/pix/logobgrightgreen.jpg [deleted file]
theme/splash/pix/logobgrightorange.jpg [deleted file]
theme/splash/pix/orange-theme.jpg [deleted file]
theme/splash/pix/orange-theme2.jpg [deleted file]
theme/splash/pix/orange.jpg [deleted file]
theme/splash/pix/post-sbbg.jpg [deleted file]
theme/splash/pix/post-sbheaderbg.jpg [deleted file]
theme/splash/pix/pre-sbbg.jpg [deleted file]
theme/splash/pix/pre-sbheaderbg.jpg [deleted file]
theme/splash/pix/red-theme.jpg [deleted file]
theme/splash/pix/red-theme2.jpg [deleted file]
theme/splash/pix/red.jpg [deleted file]
theme/splash/pix/sbheaderbg.jpg [deleted file]
theme/splash/pix/switchbg.jpg [deleted file]
theme/splash/pix/userinfobg.jpg [deleted file]
theme/splash/settings.php
theme/splash/style/blue.css
theme/splash/style/core.css [new file with mode: 0644]
theme/splash/style/editor.css
theme/splash/style/green.css
theme/splash/style/ie.css [deleted file]
theme/splash/style/menus.css [new file with mode: 0644]
theme/splash/style/orange.css
theme/splash/style/pagelayout.css [new file with mode: 0644]
theme/splash/style/red.css [new file with mode: 0644]
theme/splash/style/settings.css [new file with mode: 0644]
theme/splash/style/sl.css [deleted file]
theme/splash/version.php
theme/splash/yui/colourswitcher/colourswitcher.js [deleted file]
user/editadvanced.php
user/externallib.php
user/lib.php

index fa7c1aa..12f0792 100644 (file)
@@ -18,8 +18,7 @@
 /**
  * Defines the capabilities used by the Language customization admin tool
  *
- * @package    tool
- * @subpackage customlang
+ * @package    tool_customlang
  * @copyright  2010 David Mudrak <david@moodle.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 6a0c8d2..73d07dc 100644 (file)
 /**
  * Unitest caps.
  *
- * @package    tool
- * @subpackage unittest
+ * @package    tool_unittest
  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 $capabilities = array(
 
     // Note: do not add managers here, unittests are dangerous and not intended for production sites!!!
index f3a22b7..360dd63 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_activity_task class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
- * abstract activity task that provides all the properties and common tasks to be performed
- * when one activity is being backup
+ * Provides all the settings and steps to perform one complete backup of the activity
  *
- * TODO: Finish phpdocs
+ * Activities are supposed to provide the subclass of this class in their file
+ * mod/MODULENAME/backup/moodle2/backup_MODULENAME_activity_task.class.php
+ * The expected name of the subclass is backup_MODULENAME_activity_task
  */
 abstract class backup_activity_task extends backup_task {
 
@@ -38,6 +44,10 @@ abstract class backup_activity_task extends backup_task {
 
     /**
      * Constructor - instantiates one object of this class
+     *
+     * @param string $name the task identifier
+     * @param int $moduleid course module id (id in course_modules table)
+     * @param backup_plan|null $plan the backup plan instance this task is part of
      */
     public function __construct($name, $moduleid, $plan = null) {
 
@@ -59,28 +69,43 @@ abstract class backup_activity_task extends backup_task {
         parent::__construct($name, $plan);
     }
 
+    /**
+     * @return int the course module id (id in the course_modules table)
+     */
     public function get_moduleid() {
         return $this->moduleid;
     }
 
+    /**
+     * @return int the course section id (id in the course_sections table)
+     */
     public function get_sectionid() {
         return $this->sectionid;
     }
 
+    /**
+     * @return string the name of the module, eg 'workshop' (from the modules table)
+     */
     public function get_modulename() {
         return $this->modulename;
     }
 
+    /**
+     * @return int the id of the activity instance (id in the activity's instances table)
+     */
     public function get_activityid() {
         return $this->activityid;
     }
 
+    /**
+     * @return int the id of the associated CONTEXT_MODULE instance
+     */
     public function get_contextid() {
         return $this->contextid;
     }
 
     /**
-     * Activity tasks have their own directory to write files
+     * @return string full path to the directory where this task writes its files
      */
     public function get_taskbasepath() {
         return $this->get_basepath() . '/activities/' . $this->modulename . '_' . $this->moduleid;
@@ -184,9 +209,11 @@ abstract class backup_activity_task extends backup_task {
 
 
     /**
-     * Specialisation that, first of all, looks for the setting within
-     * the task with the the prefix added and later, delegates to parent
-     * without adding anything
+     * Tries to look for the instance specific setting value, task specific setting value or the
+     * common plan setting value - in that order
+     *
+     * @param string $name the name of the setting
+     * @return mixed|null the value of the setting or null if not found
      */
     public function get_setting($name) {
         $namewithprefix = $this->modulename . '_' . $this->moduleid . '_' . $name;
@@ -211,7 +238,7 @@ abstract class backup_activity_task extends backup_task {
 // Protected API starts here
 
     /**
-     * Define the common setting that any backup activity will have
+     * Defines the common setting that any backup activity will have
      */
     protected function define_settings() {
 
@@ -264,21 +291,44 @@ abstract class backup_activity_task extends backup_task {
     }
 
     /**
-     * Define (add) particular settings that each activity can have
+     * Defines activity specific settings to be added to the common ones
+     *
+     * This method is called from {@link self::define_settings()}. The activity module
+     * author may use it to define additional settings that influence the execution of
+     * the backup.
+     *
+     * Most activities just leave the method empty.
+     *
+     * @see self::define_settings() for the example how to define own settings
      */
     abstract protected function define_my_settings();
 
     /**
-     * Define (add) particular steps that each activity can have
+     * Defines activity specific steps for this task
+     *
+     * This method is called from {@link self::build()}. Activities are supposed
+     * to call {self::add_step()} in it to include their specific steps in the
+     * backup plan.
      */
     abstract protected function define_my_steps();
 
     /**
-     * Code the transformations to perform in the activity in
-     * order to get transportable (encoded) links
+     * Encodes URLs to the activity instance's scripts into a site-independent form
+     *
+     * The current instance of the activity may be referenced from other places in
+     * the course by URLs like http://my.moodle.site/mod/workshop/view.php?id=42
+     * Obvisouly, such URLs are not valid any more once the course is restored elsewhere.
+     * For this reason the backup file does not store the original URLs but encodes them
+     * into a transportable form. During the restore, the reverse process is applied and
+     * the encoded URLs are replaced with the new ones valid for the target site.
+     *
+     * Every plugin must override this method in its subclass.
+     *
+     * @see backup_xml_transformer class that actually runs the transformation
+     * @param string $content some HTML text that eventually contains URLs to the activity instance scripts
+     * @return string the content with the URLs encoded
      */
     static public function encode_content_links($content) {
         throw new coding_exception('encode_content_links() method needs to be overridden in each subclass of backup_activity_task');
     }
-
 }
index 7d3f26e..91e0253 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * abstract block task that provides all the properties and common steps to be performed
  * when one block is being backup
index 070506c..8c35274 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_course_task
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 /**
index 8d89b31..ceab083 100644 (file)
@@ -24,10 +24,11 @@ defined('MOODLE_INTERNAL') || die();
  * backed up, a course report should make use of the second and third
  * parameters in get_plugin_element().
  *
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2011 onwards The Open University
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2011 onwards The Open University
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 abstract class backup_coursereport_plugin extends backup_plugin {
     // Use default parent behaviour
index d899a65..e0ceb33 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines various element classes used in specific areas
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Implementation of backup_final_element that provides one interceptor for anonymization of data
  *
index b3f5eae..4b12633 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_default_block_task class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Default block task to backup blocks that haven't own DB structures to be added
  * when one block is being backup
index 78bab3c..b9f7251 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_final_task class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Final task that provides all the final steps necessary in order to finish one
  * backup (mainly gathering references and creating the main xml) apart from
index d1af1b9..978c69a 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2011 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_format_plugin class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2011 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Class extending standard backup_plugin in order to implement some
  * helper methods related with the course formats (format plugin)
index a06412a..7fd4029 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    core
- * @subpackage backup-moodle2
- * @copyright  2011 David Mudrak <david@moodle.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_gradingform_plugin class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2011 David Mudrak <david@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
@@ -28,5 +31,4 @@ defined('MOODLE_INTERNAL') || die();
  * Base class for all advanced grading form plugins
  */
 abstract class backup_gradingform_plugin extends backup_plugin {
-
 }
index 17a1d23..86b3cc2 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2011 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_plagiarism_plugin class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2011 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Class extending standard backup_plugin in order to implement some
  * helper methods related with the plagiarism plugins (plagiarism plugin)
index 0342462..d7a1f0a 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_plan_builder class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
index da0abfa..6a060ab 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_plugin class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Class implementing the plugins support for moodle2 backups
  *
index 5d940c5..c6839a7 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_qtype_plugin class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Class extending standard backup_plugin in order to implement some
  * helper methods related with the questions (qtype plugin)
index fbc2174..8f2b34f 100644 (file)
@@ -24,10 +24,11 @@ defined('MOODLE_INTERNAL') || die();
  * backed up, a report should make use of the second and third
  * parameters in get_plugin_element().
  *
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2011 Petr Skoda
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2011 Petr Skoda
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 abstract class backup_report_plugin extends backup_plugin {
     // Use default parent behaviour
index af710e1..fc65242 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_root_task class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Start task that provides all the settings common to all backups and some initialization steps
  *
index 8986d8c..ab4b4c8 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_section_task class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * section task that provides all the properties and common steps to be performed
  * when one section is being backup
index 6614aee..fe39f2c 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines classes used to handle backup settings
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 // TODO: Reduce these to the minimum because ui/dependencies are 100% separated
@@ -36,6 +39,15 @@ class backup_generic_setting extends root_backup_setting {}
  */
 class backup_filename_setting extends backup_generic_setting {
 
+    /**
+     * Instantiates a setting object
+     *
+     * @param string $name Name of the setting
+     * @param string $vtype Type of the setting, eg {@link base_setting::IS_TEXT}
+     * @param mixed $value Value of the setting
+     * @param bool $visibility Is the setting visible in the UI, eg {@link base_setting::VISIBLE}
+     * @param int $status Status of the setting with regards to the locking, eg {@link base_setting::NOT_LOCKED}
+     */
     public function __construct($name, $vtype, $value = null, $visibility = self::VISIBLE, $status = self::NOT_LOCKED) {
         parent::__construct($name, $vtype, $value, $visibility, $status);
     }
index 8454934..b87e3cc 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines various backup steps that will be used by common tasks in backup
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-/**
- * Define all the backup steps that will be used by common tasks in backup
- */
+defined('MOODLE_INTERNAL') || die();
 
 /**
  * create the temp dir where backup/restore will happen,
@@ -98,6 +99,7 @@ abstract class backup_activity_structure_step extends backup_structure_step {
      *                                       we are going to add subplugin information to
      * @param bool $multiple to define if multiple subplugins can produce information
      *                       for each instance of $element (true) or no (false)
+     * @return void
      */
     protected function add_subplugin_structure($subplugintype, $element, $multiple) {
 
@@ -135,6 +137,8 @@ abstract class backup_activity_structure_step extends backup_structure_step {
     /**
      * As far as activity backup steps are implementing backup_subplugin stuff, they need to
      * have the parent task available for wrapping purposes (get course/context....)
+     *
+     * @return backup_activity_task
      */
     public function get_task() {
         return $this->task;
@@ -143,6 +147,9 @@ abstract class backup_activity_structure_step extends backup_structure_step {
     /**
      * Wraps any activity backup structure within the common 'activity' element
      * that will include common to all activities information like id, context...
+     *
+     * @param backup_nested_element $activitystructure the element to wrap
+     * @return backup_nested_element the $activitystructure wrapped by the common 'activity' element
      */
     protected function prepare_activity_structure($activitystructure) {
 
index ca3e953..7cb30e3 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_subplugin class
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Class implementing the subplugins support for moodle2 backups
  *
index d4a3a09..7978c52 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2011 onwards The Open University
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_theme_plugin class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2011 onwards The Open University
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Base class for theme backup plugins.
  *
index f0be3cd..a3770d0 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_xml_transformer class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Class implementing the @xml_contenttrasnformed logic to be applied in moodle2 backups
  *
index 50f305d..4872fc0 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_activity_task class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * abstract activity task that provides all the properties and common tasks to be performed
  * when one activity is being restored
index d4715d7..64e5b99 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_block_task class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * abstract block task that provides all the properties and common steps to be performed
  * when one block is being restored
index 1ab98bf..87828b4 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_course_task class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * course task that provides all the properties and common steps to be performed
  * when one course is being restored
index 9a94e23..af0ebb0 100644 (file)
@@ -19,10 +19,11 @@ defined('MOODLE_INTERNAL') || die();
 /**
  * Restore for course plugin: course report.
  *
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright 2011 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2011 The Open University
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 abstract class restore_coursereport_plugin extends restore_plugin {
     // Use default parent behaviour
index c3267a2..78c3577 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_default_block_task class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Default block task to restore blocks not having own DB structures to be added
  *
index cebf2ea..09a9db3 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_final_task class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Final task that provides all the final steps necessary in order to finish one
  * restore like gradebook, interlinks... apart from some final cleaning
index 454d3a8..ce7f030 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2011 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_format_plugin class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2011 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Class extending standard restore_plugin in order to implement some
  * helper methods related with the course formats (format plugin)
index ff7f998..6caa7dc 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    core
- * @subpackage backup-moodle2
- * @copyright  2011 David Mudrak <david@moodle.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_gradingform_plugin class
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2011 David Mudrak <david@moodle.com>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
index 039d117..6b80a41 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2011 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_plagiarism_plugin class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2011 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Class extending standard restore_plugin in order to implement some
  * helper methods related with the plagiarism plugins
index 22511ce..faf4a12 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_plan_builder class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
index 5ed177e..d85790b 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_plugin class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Class implementing the plugins support for moodle2 restore
  *
index 42c6c1d..40b06ac 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_qtype_plugin class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Class extending standard restore_plugin in order to implement some
  * helper methods related with the questions (qtype plugin)
index 7db2151..bc42c89 100644 (file)
@@ -19,10 +19,11 @@ defined('MOODLE_INTERNAL') || die();
 /**
  * Restore for plugin report.
  *
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2011 Petr Skoda
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2011 Petr Skoda
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 abstract class restore_report_plugin extends restore_plugin {
     // Use default parent behaviour
index a5163e9..ac3f81d 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_root_task class
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Start task that provides all the settings common to all restores and other initial steps
  *
index 5c03bcb..4efd4e8 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_section_task class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * section task that provides all the properties and common steps to be performed
  * when one section is being restored
index 6d8b162..6be3cc2 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines classes used to handle restore settings
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 // TODO: Reduce these to the minimum because ui/dependencies are 100% separated
 
 // Root restore settings
index acf17be..e62129b 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package moodlecore
- * @subpackage backup-moodle2
- * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines various restore steps that will be used by common tasks in restore
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-/**
- * Define all the restore steps that will be used by common tasks in restore
- */
+defined('MOODLE_INTERNAL') || die();
 
 /**
  * delete old directories and conditionally create backup_temp_ids table
index 8972e35..bf21779 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines restore_subplugin class
+ *
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Class implementing the subplugins support for moodle2 restore
  *
index 8493194..1935d44 100644 (file)
@@ -19,10 +19,11 @@ defined('MOODLE_INTERNAL') || die();
 /**
  * Restore for course plugin: theme.
  *
- * @package    moodlecore
- * @subpackage backup-moodle2
- * @copyright 2011 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package     core_backup
+ * @subpackage  moodle2
+ * @category    backup
+ * @copyright   2011 The Open University
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 abstract class restore_theme_plugin extends restore_plugin {
     // Use default parent behaviour
index 2d19245..8b6c3f0 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-settings
- * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines backup_setting class
+ *
+ * @package     core_backup
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
- * This abstract class defines one backup_setting
- *
- * TODO: Finish phpdocs
+ * Parent class for all backup settings
  */
 abstract class backup_setting extends base_setting implements checksumable {
 
@@ -35,12 +37,12 @@ abstract class backup_setting extends base_setting implements checksumable {
     const SECTION_LEVEL  = 9;
     const ACTIVITY_LEVEL = 13;
 
+    /** @var int Level of the setting, eg {@link self::ROOT_LEVEL} */
+    protected $level;
+
     /**
-     * One of the above constants
-     * @var {int}
+     * {@inheritdoc}
      */
-    protected $level;  // level of the setting
-
     public function __construct($name, $vtype, $value = null, $visibility = self::VISIBLE, $status = self::NOT_LOCKED) {
         parent::__construct($name, $vtype, $value, $visibility, $status);
         // Generate a default ui
@@ -48,9 +50,7 @@ abstract class backup_setting extends base_setting implements checksumable {
     }
 
     /**
-     * Returns the level of the setting
-     *
-     * @return {int} One of the above constants
+     * @return int Level of the setting, eg {@link self::ROOT_LEVEL}
      */
     public function get_level() {
         return $this->level;
@@ -112,7 +112,7 @@ abstract class backup_setting extends base_setting implements checksumable {
     }
 }
 
-/*
+/**
  * Exception class used by all the @backup_setting stuff
  */
 class backup_setting_exception extends base_setting_exception {
index 82e6eb1..558b0c2 100644 (file)
@@ -86,6 +86,15 @@ abstract class base_setting {
      */
     protected $help = array();
 
+    /**
+     * Instantiates a setting object
+     *
+     * @param string $name Name of the setting
+     * @param string $vtype Type of the setting, eg {@link self::IS_TEXT}
+     * @param mixed $value Value of the setting
+     * @param bool $visibility Is the setting visible in the UI, eg {@link self::VISIBLE}
+     * @param int $status Status of the setting with regards to the locking, eg {@link self::NOT_LOCKED}
+     */
     public function __construct($name, $vtype, $value = null, $visibility = self::VISIBLE, $status = self::NOT_LOCKED) {
         // Check vtype
         if ($vtype !== self::IS_BOOLEAN && $vtype !== self::IS_INTEGER &&
index 62a0f17..7b459e6 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-settings
- * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * Defines root_backup_setting class
+ *
+ * @package     core_backup
+ * @category    backup
+ * @copyright   2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 /**
  * Abstract class containing all the common stuff for root backup settings
- *
- * TODO: Finish phpdocs
  */
 abstract class root_backup_setting extends backup_setting {
 
+    /**
+     * {@inheritdoc}
+     */
     public function __construct($name, $vtype, $value = null, $visibility = self::VISIBLE, $status = self::NOT_LOCKED) {
         $this->level = self::ROOT_LEVEL;
         parent::__construct($name, $vtype, $value, $visibility, $status);
index 8daffbf..dbd9e07 100644 (file)
@@ -128,7 +128,7 @@ if ($usercandownload and $download != -1 and !empty($downloadcourseid) and confi
 $remove = optional_param('remove', '', PARAM_INTEGER);
 $communityid = optional_param('communityid', '', PARAM_INTEGER);
 if ($remove != -1 and !empty($communityid) and confirm_sesskey()) {
-    $communitymanager->block_community_remove_course($communityid, $USER->id); 
+    $communitymanager->block_community_remove_course($communityid, $USER->id);
     echo $OUTPUT->header();
     echo $renderer->remove_success(new moodle_url(get_referer(false)));
     echo $OUTPUT->footer();
@@ -245,4 +245,4 @@ if (!empty($courses)) {
     }
 }
 
-echo $OUTPUT->footer();
\ No newline at end of file
+echo $OUTPUT->footer();
index f76088f..5c39f75 100644 (file)
@@ -82,7 +82,7 @@ class block_community_manager {
         global $CFG, $USER;
         require_once($CFG->libdir . "/filelib.php");
         require_once($CFG->dirroot. "/course/publish/lib.php");
-             
+
         $params['courseid'] = $course->id;
         $params['filetype'] = HUB_BACKUP_FILE_TYPE;
 
@@ -104,7 +104,7 @@ class block_community_manager {
             $token = $registeredhub->token;
             $curlurl .= '&token='.$token;
         }
-        
+
         $ch = curl_init($curlurl);
         curl_setopt($ch, CURLOPT_FILE, $fp);
         $data = curl_exec($ch);
@@ -143,4 +143,4 @@ class block_community_manager {
                 array('userid' => $userid, 'id' => $communityid));
     }
 
-}
\ No newline at end of file
+}
index 1df8f82..4fb6c50 100644 (file)
@@ -124,7 +124,7 @@ class block_community_renderer extends plugin_renderer_base {
                 //create title html
                 $coursename = html_writer::tag('h3', $course->fullname,
                                 array('class' => 'hubcoursetitle'));
-                $coursenamehtml = html_writer::tag('div', $coursename, 
+                $coursenamehtml = html_writer::tag('div', $coursename,
                         array('class' => 'hubcoursetitlepanel'));
 
                 // create screenshots html
index 4671ad2..f91abb0 100644 (file)
@@ -44,12 +44,12 @@ YUI.add('moodle-block_community-imagegallery', function(Y) {
 
             this.overlay.render();
             this.overlay.hide();
-           
+
             //attach a show event on the image divs (<tag id='image-X'>)
             for (var i=0;i<this.get('imageids').length;i++)
             {
                 var imageid = this.get('imageids')[i];
-                this.imageidnumbers[imageid] = this.get('imagenumbers')[i];              
+                this.imageidnumbers[imageid] = this.get('imagenumbers')[i];
                 Y.one('#image-'+imageid).on('click', this.show, this, imageid, 1);
             }
 
@@ -60,9 +60,9 @@ YUI.add('moodle-block_community-imagegallery', function(Y) {
             if (this.imageloadingevent != null) {
                 this.imageloadingevent.detach();
             }
-            
+
             var url = this.get('huburl') + "/local/hub/webservice/download.php?courseid="
-            + imageid + "&filetype=screenshot&imagewidth=original&screenshotnumber=" + screennumber;  
+            + imageid + "&filetype=screenshot&imagewidth=original&screenshotnumber=" + screennumber;
 
             /// set the mask
             if (this.get('maskNode')) {
@@ -88,17 +88,17 @@ YUI.add('moodle-block_community-imagegallery', function(Y) {
             var overlaytitle = Y.one('#imagetitleoverlay');
             var previousimagelink = "<div id=\"previousarrow\" class=\"imagearrow\">←</div>";
             var nextimagelink = "<div id=\"nextarrow\" class=\"imagearrow\">→</div>";
-           
+
             /// need to load the images in the overlay
             var overlay = Y.one('#imageoverlay');
             overlay.setContent('');
-          
+
 
             overlay.append(Y.Node.create('<div style="text-align:center"><img id=\"imagetodisplay\" src="' + url
                 + '" style="max-height:' + maxheight + 'px;"></div>'));
             this.overlay.destroy();
             this.overlay = new M.core.dialogue({
-                headerContent:previousimagelink + '<div id=\"imagenumber\" class=\"imagetitle\"> Image ' 
+                headerContent:previousimagelink + '<div id=\"imagenumber\" class=\"imagetitle\"> Image '
                 + screennumber + ' / ' + this.imageidnumbers[imageid] + ' </div>' + nextimagelink,
                 bodyContent:Y.one('#imageoverlay').get('innerHTML'),
                 visible: false, //by default it is not displayed
@@ -127,7 +127,7 @@ YUI.add('moodle-block_community-imagegallery', function(Y) {
                 if(overlaywidth > screenshot.width) {
                     overlaywidth = screenshot.width;
                 }
-                
+
                 this.overlay.set('width', overlaywidth);
                 this.overlay.set("centered", true);
                 this.overlay.show();
@@ -196,4 +196,4 @@ YUI.add('moodle-block_community-imagegallery', function(Y) {
 
 }, '@VERSION@', {
     requires:['base','node','overlay', 'moodle-enrol-notification']
-});
\ No newline at end of file
+});
index 7013b12..07a7b47 100644 (file)
@@ -36,7 +36,7 @@ require_once($CFG->libdir.'/completionlib.php');
 class block_completionstatus extends block_base {
 
     public function init() {
-        $this->title   = get_string('completionstatus', 'block_completionstatus');
+        $this->title   = get_string('pluginname', 'block_completionstatus');
     }
 
     public function get_content() {
index 50bea4e..fcc965a 100644 (file)
@@ -1,7 +1,6 @@
 <?php
 
 $string['completionprogressdetails'] = 'Completion progress details';
-$string['completionstatus'] = 'Course completion status';
 $string['criteriagroup'] = 'Criteria group';
 $string['firstofsecond'] = '{$a->first} of {$a->second}';
 $string['pluginname'] = 'Course completion status';
index 3c773a6..282f9e2 100644 (file)
@@ -4,7 +4,7 @@ include_once($CFG->dirroot . '/course/lib.php');
 
 class block_course_list extends block_list {
     function init() {
-        $this->title = get_string('courses');
+        $this->title = get_string('pluginname', 'block_course_list');
     }
 
     function has_config() {
index a30a5c0..4e79fc1 100644 (file)
@@ -29,4 +29,4 @@ $string['configadminview'] = 'What should the admin see in the course list block
 $string['confighideallcourseslink'] = 'Hide "All courses" link at the bottom of the block. Link hiding does not affects Admin\'s view';
 $string['hideallcourseslink'] = 'Hide All courses link';
 $string['owncourses'] = 'Admin user sees own courses';
-$string['pluginname'] = 'Course list';
+$string['pluginname'] = 'Courses';
index c01445f..5560a32 100644 (file)
@@ -478,7 +478,7 @@ M.core_dock.delayEvent = function(event, options, target) {
  */
 M.core_dock.fixTitleOrientation = function(item, title, text) {
     var Y = this.Y;
-    
+
     var title = Y.one(title);
 
     if(M.core_dock.cfg.orientation != 'vertical') {
@@ -809,7 +809,7 @@ M.core_dock.genericblock.prototype = {
      */
     initialise_block : function(Y, node) {
         M.core_dock.init(Y);
-        
+
         this.Y = Y;
         if (!node) {
             return false;
@@ -919,7 +919,7 @@ M.core_dock.genericblock.prototype = {
         // Register an event so that when it is removed we can put it back as a block
         dockitem.on('dockeditem:itemremoved', this.return_to_block, this, dockitem);
         dock.add(dockitem);
-        
+
         if (!this.skipsetposition) {
             // save the users preference
             M.util.set_user_preference('docked_block_instance_'+this.id, 1);
index 4d8fc11..17d98ce 100644 (file)
 /**
  * Form for editing HTML block instances.
  *
- * @package   block_html
  * @copyright 2010 Petr Skoda (http://skodak.org)
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package   block_html
+ * @category  files
+ * @param stdClass $course course object
+ * @param stdClass $birecord_or_cm block instance record
+ * @param stdClass $context context object
+ * @param string $filearea file area
+ * @param array $args extra arguments
+ * @param bool $forcedownload whether or not force download
+ * @return bool
  */
-
 function block_html_pluginfile($course, $birecord_or_cm, $context, $filearea, $args, $forcedownload) {
     global $SCRIPT;
 
@@ -79,4 +86,4 @@ function block_html_global_db_replace($search, $replace) {
         }
     }
     $instances->close();
-}
\ No newline at end of file
+}
index 8bfa9b7..2d03518 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -19,8 +18,8 @@
  * This file contains classes used to manage the navigation structures in Moodle
  * and was introduced as part of the changes occuring in Moodle 2.0
  *
- * @since 2.0
- * @package blocks
+ * @since     2.0
+ * @package   block_navigation
  * @copyright 2009 Sam Hemelryk
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
  *
  * Used to produce the global navigation block new to Moodle 2.0
  *
- * @package blocks
+ * @package   block_navigation
+ * @category  navigation
  * @copyright 2009 Sam Hemelryk
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class block_navigation extends block_base {
 
-    /** @var int */
+    /** @var int This allows for multiple navigation trees */
     public static $navcount;
-    /** @var string */
+    /** @var string The name of the block */
     public $blockname = null;
-    /** @var bool */
+    /** @var bool A switch to indicate whether content has been generated or not. */
     protected $contentgenerated = false;
-    /** @var bool|null */
+    /** @var bool|null variable for checking if the block is docked*/
     protected $docked = null;
 
     /** @var int Trim characters from the right */
@@ -63,7 +63,7 @@ class block_navigation extends block_base {
 
     /**
      * All multiple instances of this block
-     * @return bool Returns true
+     * @return bool Returns false
      */
     function instance_allow_multiple() {
         return false;
@@ -95,10 +95,18 @@ class block_navigation extends block_base {
         return false;
     }
 
+    /**
+     * Find out if an instance can be docked.
+     *
+     * @return bool true or false depending on whether the instance can be docked or not.
+     */
     function instance_can_be_docked() {
         return (parent::instance_can_be_docked() && (empty($this->config->enabledock) || $this->config->enabledock=='yes'));
     }
 
+    /**
+     * Gets Javascript that may be required for navigation
+     */
     function get_required_javascript() {
         global $CFG;
         user_preference_allow_ajax_update('docked_block_instance_'.$this->instance->id, PARAM_INT);
@@ -124,6 +132,8 @@ class block_navigation extends block_base {
 
     /**
      * Gets the content for this block by grabbing it from $this->page
+     *
+     * @return object $this->content
      */
     function get_content() {
         global $CFG, $OUTPUT;
@@ -134,7 +144,7 @@ class block_navigation extends block_base {
         // JS for navigation moved to the standard theme, the code will probably have to depend on the actual page structure
         // $this->page->requires->js('/lib/javascript-navigation.js');
         // Navcount is used to allow us to have multiple trees although I dont' know why
-        // you would want to trees the same
+        // you would want two trees the same
 
         block_navigation::$navcount++;
 
@@ -192,7 +202,7 @@ class block_navigation extends block_base {
 
         $options = array();
         $options['linkcategories'] = (!empty($this->config->linkcategories) && $this->config->linkcategories == 'yes');
-        
+
         // Grab the items to display
         $renderer = $this->page->get_renderer('block_navigation');
         $this->content = new stdClass();
@@ -208,10 +218,10 @@ class block_navigation extends block_base {
      * Returns the attributes to set for this block
      *
      * This function returns an array of HTML attributes for this block including
-     * the defaults
-     * {@link block_tree->html_attributes()} is used to get the default arguments
+     * the defaults.
+     * {@link block_tree::html_attributes()} is used to get the default arguments
      * and then we check whether the user has enabled hover expansion and add the
-     * appropriate hover class if it has
+     * appropriate hover class if it has.
      *
      * @return array An array of HTML attributes
      */
@@ -227,6 +237,7 @@ class block_navigation extends block_base {
      * Trims the text and shorttext properties of this node and optionally
      * all of its children.
      *
+     * @param navigation_node $node
      * @param int $mode One of navigation_node::TRIM_*
      * @param int $long The length to trim text to
      * @param int $short The length to trim shorttext to
index 0d36b6b..3134e59 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -18,8 +17,8 @@
 /**
  * Form for editing global navigation instances.
  *
- * @since 2.0
- * @package blocks
+ * @since     2.0
+ * @package   block_navigation
  * @copyright 2009 Sam Hemelryk
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -27,7 +26,8 @@
 /**
  * Form for editing global navigation instances.
  *
- * @package blocks
+ * @package   block_navigation
+ * @category  navigation
  * @copyright 2009 Sam Hemelryk
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index b62d4db..fe91aed 100644 (file)
@@ -1,7 +1,45 @@
 <?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/>.
 
+/**
+ * Outputs the navigation tree.
+ *
+ * @since     2.0
+ * @package   block_navigation
+ * @copyright 2009 Sam Hemelryk
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Renderer for block navigation
+ *
+ * @package   block_navigation
+ * @category  navigation
+ * @copyright 2009 Sam Hemelryk
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 class block_navigation_renderer extends plugin_renderer_base {
-    
+    /**
+     * Returns the content of the navigation tree.
+     *
+     * @param global_navigation $navigation
+     * @param int $expansionlimit
+     * @param array $options
+     * @return string $content
+     */
     public function navigation_tree(global_navigation $navigation, $expansionlimit, array $options = array()) {
         $navigation->add_class('navigation_node');
         $content = $this->navigation_node(array($navigation), array('class'=>'block_tree list'), $expansionlimit, $options);
@@ -10,7 +48,16 @@ class block_navigation_renderer extends plugin_renderer_base {
         }
         return $content;
     }
-
+    /**
+     * Produces a navigation node for the navigation tree
+     *
+     * @param array $items
+     * @param array $attrs
+     * @param int $expansionlimit
+     * @param array $options
+     * @param int $depth
+     * @return string
+     */
     protected function navigation_node($items, $attrs=array(), $expansionlimit=null, array $options = array(), $depth=1) {
 
         // exit if empty, we don't want an empty ul element
@@ -116,4 +163,4 @@ class block_navigation_renderer extends plugin_renderer_base {
         }
     }
 
-}
\ No newline at end of file
+}
index 3d5bf5e..fee1d15 100644 (file)
@@ -17,8 +17,7 @@
 /**
  * Version details
  *
- * @package    block
- * @subpackage navigation
+ * @package    block_navigation
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index d042fac..ff00c60 100644 (file)
@@ -1,27 +1,28 @@
 <?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/>.
 
-///////////////////////////////////////////////////////////////////////////
-//                                                                       //
-// NOTICE OF COPYRIGHT                                                   //
-//                                                                       //
-// Moodle - Modular Object-Oriented Dynamic Learning Environment         //
-//          http://moodle.com                                            //
-//                                                                       //
-// Copyright (C) 1999 onwards  Martin Dougiamas  http://moodle.com       //
-//                                                                       //
-// This program 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 2 of the License, or     //
-// (at your option) any later version.                                   //
-//                                                                       //
-// This program 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:                          //
-//                                                                       //
-//          http://www.gnu.org/copyleft/gpl.html                         //
-//                                                                       //
-///////////////////////////////////////////////////////////////////////////
+/**
+ * Online users block caps.
+ *
+ * @package    block_online_users
+ * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
 
 $capabilities = array(
 
index 5779210..deeeb7d 100644 (file)
@@ -19,10 +19,13 @@ class block_participants extends block_list {
         $this->content->icons = array();
         $this->content->footer = '';
 
-        /// MDL-13252 Always get the course context or else the context may be incorrect in the user/index.php
-        $currentcontext = $this->page->context;
+        // user/index.php expect course context, so get one if page has module context.
+        $currentcontext = $this->page->context->get_course_context(false);
 
-        if ($this->page->course->id == SITEID) {
+        if (empty($currentcontext)) {
+            $this->content = '';
+            return $this->content;
+        } else if ($this->page->course->id == SITEID) {
             if (!has_capability('moodle/site:viewparticipants', get_context_instance(CONTEXT_SYSTEM))) {
                 $this->content = '';
                 return $this->content;
@@ -33,6 +36,7 @@ class block_participants extends block_list {
                 return $this->content;
             }
         }
+
         $icon = '<img src="'.$OUTPUT->pix_url('i/users') . '" class="icon" alt="" />&nbsp;';
         $this->content->items[] = '<a title="'.get_string('listofallpeople').'" href="'.
                                   $CFG->wwwroot.'/user/index.php?contextid='.$currentcontext->id.'">'.$icon.get_string('participants').'</a>';
@@ -46,5 +50,3 @@ class block_participants extends block_list {
     }
 
 }
-
-
index 32e1282..594f276 100644 (file)
@@ -27,7 +27,7 @@
 class block_private_files extends block_base {
 
     function init() {
-        $this->title = get_string('myfiles');
+        $this->title = get_string('pluginname', 'block_private_files');
     }
 
     function specialization() {
index f13e21f..e3970e6 100644 (file)
@@ -24,5 +24,5 @@
  */
 
 $string['managemyfiles'] = 'Manage my files';
-$string['pluginname'] = 'User private files';
+$string['pluginname'] = 'My private files';
 $string['privatefiles'] = 'Private files';
index 8ca1504..a3aa511 100644 (file)
@@ -26,7 +26,7 @@
  class block_rss_client extends block_base {
 
     function init() {
-        $this->title = get_string('feedstitle', 'block_rss_client');
+        $this->title = get_string('pluginname', 'block_rss_client');
     }
 
     function preferred_width() {
index 45cbf74..6eeb862 100644 (file)
@@ -1,32 +1,28 @@
 <?php
-//
-// Capability definitions for the rss_client block.
-//
-// The capabilities are loaded into the database table when the block is
-// installed or updated. Whenever the capability definitions are updated,
-// the module version number should be bumped up.
-//
-// The system has four possible values for a capability:
-// CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT, and inherit (not set).
-//
-//
-// CAPABILITY NAMING CONVENTION
-//
-// It is important that capability names are unique. The naming convention
-// for capabilities that are specific to modules and blocks is as follows:
-//   [mod/block]/<plugin_name>:<capabilityname>
-//
-// component_name should be the same as the directory name of the mod or block.
-//
-// Core moodle capabilities are defined thus:
-//    moodle/<capabilityclass>:<capabilityname>
-//
-// Examples: mod/forum:viewpost
-//           block/recent_activity:view
-//           moodle/site:deleteuser
-//
-// The variable name for the capability definitions array is $capabilities
-
+// 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/>.
+
+/**
+ * RSS client block caps.
+ *
+ * @package    block_rss_client
+ * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
 
 $capabilities = array(
 
index 5711917..d25e090 100644 (file)
@@ -220,7 +220,7 @@ if ($mform->is_cancelled()) {
 
     $settingsurl = new moodle_url('/admin/settings.php?section=blocksettingrss_client');
     $PAGE->navbar->add(get_string('blocks'));
-    $PAGE->navbar->add(get_string('feedstitle', 'block_rss_client'), $settingsurl);
+    $PAGE->navbar->add(get_string('pluginname', 'block_rss_client'), $settingsurl);
     $PAGE->navbar->add(get_string('managefeeds', 'block_rss_client'));
     $PAGE->navbar->add($strtitle);
 
index aa809ef..33ca817 100644 (file)
@@ -52,7 +52,6 @@ $string['feeds'] = 'News feeds';
 $string['feedsaddedit'] = 'Add/edit feeds';
 $string['feedsconfigurenewinstance'] = 'Click here to configure this block to display RSS feeds.';
 $string['feedsconfigurenewinstance2'] = 'Click the edit icon above to configure this block to display RSS feeds.';
-$string['feedstitle'] = 'Remote RSS Feeds';
 $string['feedupdated'] = 'News feed updated';
 $string['feedurl'] = 'Feed URL';
 $string['findmorefeeds'] = 'Find more RSS feeds';
@@ -61,7 +60,7 @@ $string['managefeeds'] = 'Manage all my feeds';
 $string['nofeeds'] = 'There are no RSS feeds defined for this site.';
 $string['numentries'] = 'Entries per feed';
 $string['pickfeed'] = 'Pick a news feed';
-$string['pluginname'] = 'RSS client';
+$string['pluginname'] = 'Remote RSS feeds';
 $string['remotenewsfeed'] = 'Remote news feed';
 $string['rss_client:createprivatefeeds'] = 'Create private RSS feeds';
 $string['rss_client:createsharedfeeds'] = 'Create shared RSS feeds';
index 553a619..321aed4 100644 (file)
@@ -86,7 +86,7 @@ $PAGE->set_heading($strmanage);
 $settingsurl = new moodle_url('/admin/settings.php?section=blocksettingrss_client');
 $managefeeds = new moodle_url('/blocks/rss_client/managefeeds.php', $urlparams);
 $PAGE->navbar->add(get_string('blocks'));
-$PAGE->navbar->add(get_string('feedstitle', 'block_rss_client'), $settingsurl);
+$PAGE->navbar->add(get_string('pluginname', 'block_rss_client'), $settingsurl);
 $PAGE->navbar->add(get_string('managefeeds', 'block_rss_client'), $managefeeds);
 echo $OUTPUT->header();
 
index ef8da29..469e621 100644 (file)
@@ -74,7 +74,7 @@ $PAGE->set_heading($strviewfeed);
 $settingsurl = new moodle_url('/admin/settings.php?section=blocksettingrss_client');
 $managefeeds = new moodle_url('/blocks/rss_client/managefeeds.php', $urlparams);
 $PAGE->navbar->add(get_string('blocks'));
-$PAGE->navbar->add(get_string('feedstitle', 'block_rss_client'), $settingsurl);
+$PAGE->navbar->add(get_string('pluginname', 'block_rss_client'), $settingsurl);
 $PAGE->navbar->add(get_string('managefeeds', 'block_rss_client'));
 $PAGE->navbar->add($strviewfeed);
 echo $OUTPUT->header();
index af42b29..efc2fbc 100644 (file)
@@ -19,7 +19,7 @@
  * Section links block
  *
  * @package    moodlecore
- * @Author     Jason Hardin 
+ * @Author     Jason Hardin
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
index 9954a39..9fe4a84 100644 (file)
@@ -36,7 +36,7 @@ require_once($CFG->libdir.'/completionlib.php');
 class block_selfcompletion extends block_base {
 
     public function init() {
-        $this->title   = get_string('selfcompletion', 'block_selfcompletion');
+        $this->title   = get_string('pluginname', 'block_selfcompletion');
     }
 
     public function get_content() {
index 03cf0dc..403d0b2 100644 (file)
@@ -26,5 +26,4 @@
 $string['alreadyselfcompleted'] = 'You have already marked yourself as complete in this course';
 $string['completecourse'] = 'Complete course';
 $string['pluginname'] = 'Self completion';
-$string['selfcompletion'] = 'Self completion';
 $string['selfcompletionnotenabled'] = 'The self completion criteria has not been enabled for this course';
index 8a3d097..7ab989a 100644 (file)
@@ -68,8 +68,8 @@ $event->count_repeats();
 
 // Is used several times, and sometimes with modification if required
 $viewcalendarurl = new moodle_url(CALENDAR_URL.'view.php', array('view'=>'upcoming'));
-$viewcalendarurl->param('cal_y', date('Y', $event->timestart));
-$viewcalendarurl->param('cal_m', date('m', $event->timestart));
+$viewcalendarurl->param('cal_y', userdate($event->timestart, '%Y'));
+$viewcalendarurl->param('cal_m', userdate($event->timestart, '%m'));
 
 // If confirm is set (PARAM_BOOL) then we have confirmation of initention to delete
 if ($confirm) {
@@ -124,4 +124,4 @@ $event->time = calendar_format_event_time($event, time(), null, false);
 calendar_print_event($event, false);
 
 echo $OUTPUT->box_end();
-echo $OUTPUT->footer();
\ No newline at end of file
+echo $OUTPUT->footer();
index dd98be3..130e682 100644 (file)
@@ -168,9 +168,9 @@ if ($data) {
 
     $params = array(
         'view' => 'day',
-        'cal_d' => date('j', $event->timestart),
-        'cal_m' => date('n', $event->timestart),
-        'cal_y' => date('y', $event->timestart),
+        'cal_d' => userdate($event->timestart, '%d'),
+        'cal_m' => userdate($event->timestart, '%m'),
+        'cal_y' => userdate($event->timestart, '%Y'),
     );
     $eventurl = new moodle_url('/calendar/view.php', $params);
     if (!empty($event->courseid) && $event->courseid != SITEID) {
index e4e76cd..645ae18 100644 (file)
@@ -1510,7 +1510,7 @@ function calendar_get_default_courses() {
     $courses = array();
     if (!empty($CFG->calendar_adminseesall) && has_capability('moodle/calendar:manageentries', get_context_instance(CONTEXT_SYSTEM))) {
         list ($select, $join) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
-        $sql = "SELECT c.* $select
+        $sql = "SELECT DISTINCT c.* $select
                   FROM {course} c
                   JOIN {event} e ON e.courseid = c.id
                   $join";
@@ -1622,13 +1622,13 @@ function calendar_format_event_time($event, $now, $linkparams = null, $usecommon
             }
         }
     } else {
-        $time = ' ';
+        $time = calendar_time_representation($event->timestart);
 
         // Set printable representation
         if (!$showtime) {
             $day = calendar_day_representation($event->timestart, $now, $usecommonwords);
             $url = calendar_get_link_href(new moodle_url(CALENDAR_URL.'view.php', $linkparams), $startdate['mday'], $startdate['mon'], $startdate['year']);
-            $eventtime = html_writer::link($url, $day).trim($time);
+            $eventtime = html_writer::link($url, $day).', '.trim($time);
         } else {
             $eventtime = $time;
         }
index 354c6a1..e6ffef8 100644 (file)
@@ -144,12 +144,12 @@ if ($form->is_cancelled()){
 
     // Update course total passing grade
     if (!empty($data->criteria_grade)) {
-       if ($grade_item = grade_category::fetch_course_category($course->id)->grade_item) {
-               $grade_item->gradepass = $data->criteria_grade_value;
-               if (method_exists($grade_item, 'update')) {
-               $grade_item->update('course/completion.php');
-               }
-       }
+        if ($grade_item = grade_category::fetch_course_category($course->id)->grade_item) {
+            $grade_item->gradepass = $data->criteria_grade_value;
+            if (method_exists($grade_item, 'update')) {
+                $grade_item->update('course/completion.php');
+            }
+        }
     }
 
     redirect($CFG->wwwroot."/course/view.php?id=$course->id", get_string('changessaved'));
index aca5105..4da6eb3 100644 (file)
@@ -37,7 +37,7 @@
     $PAGE->set_pagelayout('popup');
     $PAGE->set_url('/course/info.php', array('id' => $course->id));
     $PAGE->set_title(get_string("summaryof", "", $course->fullname));
-    $PAGE->set_heading('Course info');
+    $PAGE->set_heading(get_string('courseinfo'));
     $PAGE->set_course($course);
     $PAGE->navbar->add(get_string('summary'));
 
index 84a9852..3b5e8df 100644 (file)
@@ -333,7 +333,7 @@ class course_publication_form extends moodleform {
 
         $editoroptions = array('maxfiles' => 0, 'maxbytes' => 0, 'trusttext' => false, 'forcehttps' => false);
         $mform->addElement('editor', 'creatornotes', get_string('creatornotes', 'hub'), '', $editoroptions);
-        $mform->addRule('creatornotes', $strrequired, 'required', null, 'client');  
+        $mform->addRule('creatornotes', $strrequired, 'required', null, 'client');
         $mform->setType('creatornotes', PARAM_CLEANHTML);
         $mform->addHelpButton('creatornotes', 'creatornotes', 'hub');
 
index 9627750..f868ca3 100644 (file)
@@ -110,11 +110,11 @@ if (has_capability('moodle/course:publish', get_context_instance(CONTEXT_COURSE,
     }
 
     $renderer = $PAGE->get_renderer('core', 'publish');
-  
+
     /// UNPUBLISH
     $cancel = optional_param('cancel', 0, PARAM_BOOL);
     if (!empty($cancel) and confirm_sesskey()) {
-        $confirm = optional_param('confirm', 0, PARAM_BOOL);      
+        $confirm = optional_param('confirm', 0, PARAM_BOOL);
         $hubcourseid = optional_param('hubcourseid', 0, PARAM_INT);
         $publicationid = optional_param('publicationid', 0, PARAM_INT);
         $timepublished = optional_param('timepublished', 0, PARAM_INT);
@@ -161,7 +161,7 @@ if (has_capability('moodle/course:publish', get_context_instance(CONTEXT_COURSE,
                 empty($hubname)?$huburl:$hubname), 'notifysuccess');
     }
 
+
     /// OUTPUT
     echo $OUTPUT->header();
     echo $confirmmessage;
@@ -177,4 +177,4 @@ if (has_capability('moodle/course:publish', get_context_instance(CONTEXT_COURSE,
 
     echo $OUTPUT->footer();
 
-}
\ No newline at end of file
+}
index 4d166eb..fe13219 100644 (file)
@@ -279,7 +279,7 @@ class course_publish_manager {
                 $subsublevel[substr($key, 0, 8)][substr($key, 0, 10)][$key] = $option;
             }
         }
-        
+
         //recreate the initial structure returned by get_string_manager()
         $subjects = array();
         foreach ($toplevel as $key => $name) {
index b8a8caa..9067f79 100644 (file)
@@ -184,10 +184,10 @@ if (has_capability('moodle/course:publish', get_context_instance(CONTEXT_COURSE,
         }
 
         // PUBLISH ACTION
-        
+
         //publish the course information
         $function = 'hub_register_courses';
-        $params = array('courses' => array($courseinfo));     
+        $params = array('courses' => array($courseinfo));
         try {
             $courseids = $xmlrpcclient->call($function, $params);
         } catch (Exception $e) {
index 64483e8..970fed5 100644 (file)
@@ -119,7 +119,7 @@ class core_publish_renderer extends plugin_renderer_base {
                                     . $courseid . "&updatestatusid=" . $publication->id
                                     . "&sesskey=" . sesskey()));
             }
-            //add button cells     
+            //add button cells
             $cells = array($publication->enrollable ?
                         get_string('advertised', 'hub') : get_string('shared', 'hub'),
                 $hubname, userdate($publication->timepublished,
@@ -207,7 +207,7 @@ class core_publish_renderer extends plugin_renderer_base {
         $hubdescription .= html_writer::tag('a', $hubinfo['name'],
                         array('class' => 'hublink', 'href' => $hubinfo['url'],
                             'onclick' => 'this.target="_blank"'));
-        
+
         $hubdescription .= html_writer::tag('div', format_text($hubinfo['description'], FORMAT_PLAIN),
                         array('class' => 'hubdescription'));
         $hubdescription = html_writer::tag('div', $hubdescription, array('class' => 'hubinfo'));
index c04804b..9f0f047 100644 (file)
@@ -1,4 +1,29 @@
 <?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/>.
+
+/**
+ * Authorize.Net enrolment plugin capabilities.
+ *
+ * @package    enrol_authorize
+ * @copyright  2006 Eugene Venter
+ * @author     Eugene Venter
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
 
 $capabilities = array(
 
index 8c24b96..1a9ead0 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -18,8 +17,7 @@
 /**
  * Capabilities for category access plugin.
  *
- * @package    enrol
- * @subpackage category
+ * @package    enrol_category
  * @copyright  2010 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 37b2d64..66194df 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * category enrolment plugin event handler definition.
+ * Category enrolment plugin event handler definition.
  *
- * @package    enrol
- * @subpackage category
- * @copyright  2010 Petr Skoda {@link http://skodak.org}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package enrol_category
+ * @category event
+ * @copyright 2010 Petr Skoda {@link http://skodak.org}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
@@ -42,4 +41,4 @@ $handlers = array (
         'internal'         => 1,
     ),
 
-);
+);
\ No newline at end of file
index 87d319b..e65d1ed 100644 (file)
@@ -79,7 +79,7 @@ switch ($action) {
         require_capability('enrol/cohort:config', $context);
         $roleid = required_param('roleid', PARAM_INT);
         $cohortid = required_param('cohortid', PARAM_INT);
-        
+
         $roles = $manager->get_assignable_roles();
         if (!enrol_cohort_can_view_cohort($cohortid) || !array_key_exists($roleid, $roles)) {
             throw new enrol_ajax_exception('errorenrolcohort');
@@ -112,4 +112,4 @@ switch ($action) {
 }
 
 echo json_encode($outcome);
-die();
\ No newline at end of file
+die();
index dcd09e8..98ce7b0 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -18,8 +17,7 @@
 /**
  * Capabilities for cohort access plugin.
  *
- * @package    enrol
- * @subpackage cohort
+ * @package    enrol_cohort
  * @copyright  2010 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 4a596aa..4f26a20 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
 /**
  * Cohort enrolment plugin event handler definition.
  *
- * @package    enrol
- * @subpackage cohort
- * @copyright  2010 Petr Skoda {@link http://skodak.org}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package enrol_cohort
+ * @category event
+ * @copyright 2010 Petr Skoda {@link http://skodak.org}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
index 2fa37e6..e2ac24d 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -18,8 +17,7 @@
 /**
  * Capabilities for guest access plugin.
  *
- * @package    enrol
- * @subpackage guest
+ * @package    enrol_guest
  * @copyright  2010 Petr Skoda  {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 8eb1aa6..8d06963 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -18,8 +17,7 @@
 /**
  * Capabilities for LDAP enrolment plugin.
  *
- * @package    enrol
- * @subpackage ldap
+ * @package    enrol_ldap
  * @author     Iñaki Arenaza
  * @copyright  2010 Iñaki Arenaza <iarenaza@eps.mondragon.edu>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
index fb2663e..e7cdf29 100644 (file)
@@ -119,7 +119,7 @@ class course_enrolment_manager {
 
     /**
      * Returns the current moodle page
-     * @return moodle_page 
+     * @return moodle_page
      */
     public function get_moodlepage() {
         return $this->moodlepage;
@@ -1269,4 +1269,4 @@ abstract class enrol_bulk_enrolment_operation {
      * @param stdClass $properties
      */
     abstract public function process(course_enrolment_manager $manager, array $users, stdClass $properties);
-}
\ No newline at end of file
+}
index 4658fc7..561ef29 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -18,8 +17,7 @@
 /**
  * Capabilities for manual enrolment plugin.
  *
- * @package    enrol
- * @subpackage manual
+ * @package    enrol_manual
  * @copyright  2010 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 54aad04..b6d41a4 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -18,8 +17,7 @@
 /**
  * Capabilities for meta link access plugin.
  *
- * @package    enrol
- * @subpackage meta
+ * @package    enrol_meta
  * @copyright  2010 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 6e4152e..c1a2d70 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
 /**
  * Meta course enrolment plugin event handler definition.
  *
- * @package    enrol
- * @subpackage meta
- * @copyright  2010 Petr Skoda {@link http://skodak.org}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package enrol_meta
+ * @category event
+ * @copyright 2010 Petr Skoda {@link http://skodak.org}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
index c474d92..f97fff9 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -18,8 +17,7 @@
 /**
  * Capabilities for paypal enrolment plugin.
  *
- * @package    enrol
- * @subpackage paypal
+ * @package    enrol_paypal
  * @copyright  2010 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 54fa9d8..314720c 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -18,8 +17,7 @@
 /**
  * Capabilities for self enrolment plugin.
  *
- * @package    enrol
- * @subpackage self
+ * @package    enrol_self
  * @copyright  2010 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 804e832..411ee98 100644 (file)
@@ -553,10 +553,10 @@ sub tolatex {
         if ($args[2]->[0] =~ /binop[12]|numberE|unop1/)
       {($p3,$p4)=qw{ \left( \right) };}
     if ($args[0] eq '/'){
-#      return('\frac{' . $p1 . $args[1]->tolatex() . $p2 . '}'.
+#   return('\frac{' . $p1 . $args[1]->tolatex() . $p2 . '}'.
 #               '{' . $p3 . $args[2]->tolatex() . $p4 . '}' );
         return('\frac{' . $args[1]->tolatex() . '}'.
-               '{' . $args[2]->tolatex() . '}' ); 
+               '{' . $args[2]->tolatex() . '}' );
     }
     else{
     return ($p1 . $args[1]->tolatex() . $p2 . $args[0] . $p3 .
index fa6af48..c6091b5 100644 (file)
@@ -138,23 +138,23 @@ class edit_scale_form extends moodleform {
             if (count($scalearray) < 2) {
                 $errors['scale'] = get_string('badlyformattedscale', 'grades');
             } else {
-                   $thescale = implode(',',$scalearray);
+                $thescale = implode(',',$scalearray);
 
-                   $textlib = textlib_get_instance();
+                $textlib = textlib_get_instance();
                 //this check strips out whitespace from the scale we're validating but not from those already in the DB
-                   $count = $DB->count_records_select('scale', "courseid=:courseid AND ".$DB->sql_compare_text('scale', $textlib->strlen($thescale)).'=:scale',
-                       array('courseid'=>$courseid, 'scale'=>$thescale));
+                $count = $DB->count_records_select('scale', "courseid=:courseid AND ".$DB->sql_compare_text('scale', $textlib->strlen($thescale)).'=:scale',
+                    array('courseid'=>$courseid, 'scale'=>$thescale));
 
                 if ($count) {
                     //if this is a new scale but we found a duplice in the DB
                     //or we found a duplicate in another course report the error
                     if (empty($old->id) or $old->courseid != $courseid) {
-                           $errors['scale'] = get_string('duplicatescale', 'grades');
+                        $errors['scale'] = get_string('duplicatescale', 'grades');
                     } else if ($old->scale !== $thescale and $old->scale !== $data['scale']) {
                         //if the old scale from DB is different but we found a duplicate then we're trying to modify a scale to be a duplicate
-                           $errors['scale'] = get_string('duplicatescale', 'grades');
-                       }
-                   }
+                        $errors['scale'] = get_string('duplicatescale', 'grades');
+                    }
+                }
             }
         }
 
index 9207be1..c5ff1eb 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * Capabilities gradeexport plugin.
+ *
+ * @package    gradeexport_ods
+ * @copyright  2007 Petr Skoda {@link http://skodak.org}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
 $capabilities = array(
 
     'gradeexport/ods:view' => array(
index 068e920..27adf4c 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * Capabilities gradeexport plugin.
+ *
+ * @package    gradeexport_txt
+ * @copyright  2007 Petr Skoda {@link http://skodak.org}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
 $capabilities = array(
 
     'gradeexport/txt:view' => array(
index 5c19916..571888f 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * Capabilities gradeexport plugin.
+ *
+ * @package    gradeexport_xls
+ * @copyright  2007 Petr Skoda {@link http://skodak.org}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
 $capabilities = array(
 
     'gradeexport/xls:view' => array(
index 068269e..3f81912 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * Capabilities gradeexport plugin.
+ *
+ * @package    gradeexport_xml
+ * @copyright  2007 Petr Skoda {@link http://skodak.org}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
 $capabilities = array(
 
     'gradeexport/xml:view' => array(
index da144c5..1288047 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * Capabilities gradeimport plugin.
+ *
+ * @package    gradeimport_csv
+ * @copyright  2007 Martin Dougiamas
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
 $capabilities = array(
 
     'gradeimport/csv:view' => array(
index 7d9460f..ff8820f 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * Capabilities gradeimport plugin.
+ *
+ * @package    gradeimport_xml
+ * @copyright  2007 Martin Dougiamas
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
 $capabilities = array(
 
     'gradeimport/xml:view' => array(
index 9859577..ef0c935 100644 (file)
@@ -22,6 +22,8 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 $capabilities = array(
 
     'gradereport/grader:view' => array(
index a4dcba6..3ad31f1 100644 (file)
@@ -22,6 +22,8 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 $capabilities = array(
 
     'gradereport/outcomes:view' => array(
index 6843f94..b33412c 100644 (file)
@@ -22,6 +22,8 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 $capabilities = array(
 
     'gradereport/overview:view' => array(
index 1090d2f..d6be476 100644 (file)
@@ -35,7 +35,7 @@ class gradereport_overview_renderer extends plugin_renderer_base {
 
     public function graded_users_selector($report, $course, $userid, $groupid, $includeall) {
         global $USER;
-        
+
         $select = grade_get_graded_users_select($report, $course, $userid, $groupid, $includeall);
         $output = html_writer::tag('div', $this->output->render($select), array('id'=>'graded_users_selector'));
         $output .= html_writer::tag('p', '', array('style'=>'page-break-after: always;'));
index ac07dbb..5a54d5b 100644 (file)
@@ -22,6 +22,8 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+defined('MOODLE_INTERNAL') || die();
+
 $capabilities = array(
 
     'gradereport/user:view' => array(
index 72bd8e6..3c0ada0 100644 (file)
@@ -128,7 +128,7 @@ $string['showguestlogin'] = 'You can hide or show the guest login button on the
 $string['stdchangepassword'] = 'Use standard page for changing password';
 $string['stdchangepassword_expl'] = 'If the external authentication system allows password changes through Moodle, switch this to Yes. This setting overrides \'Change Password URL\'.';
 $string['stdchangepassword_explldap'] = 'NOTE: It is recommended that you use LDAP over an SSL encrypted tunnel (ldaps://) if the LDAP server is remote.';
-$string['suspended'] = 'Suspended acount';
+$string['suspended'] = 'Suspended account';
 $string['suspended_help'] = 'Suspended user accounts cannot log in or use web services, and any outgoing messages are discarded.';
 $string['unlocked'] = 'Unlocked';
 $string['unlockedifempty'] = 'Unlocked if empty';
index 48a68b7..8fdab4f 100644 (file)
@@ -386,6 +386,7 @@ $string['showmaxmarkonly'] = 'Show max mark only';
 $string['showquestiontext'] = 'Show question text in the question list';
 $string['shown'] = 'Shown';
 $string['shownumpartscorrect'] = 'Show the number of correct responses';
+$string['shownumpartscorrectwhenfinished'] = 'Show the number of correct responses once the question has finished';
 $string['specificfeedback'] = 'Specific feedback';
 $string['started'] = 'Started';
 $string['state'] = 'State';
index 29aac48..bd45588 100644 (file)
  * - has_all_capabilities()
  * - require_capability()
  * - require_login() (from moodlelib)
+ * - is_enrolled()
+ * - is_viewing()
+ * - is_guest()
  * - is_siteadmin()
+ * - isguestuser()
+ * - isloggedin()
  *
  * What courses has this user access to?
  * - get_enrolled_users()
  *
  * What users can do X in this context?
- * - get_users_by_capability()
+ * - get_enrolled_users() - at and bellow course context
+ * - get_users_by_capability() - above course context
  *
  * Modify roles
  * - role_assign()
  * - role_unassign()
  * - role_unassign_all()
  *
- *
  * Advanced - for internal use only
  * - load_all_capabilities()
  * - reload_all_capabilities()
  * DB need to ensure that the default role caps
  * are dealt with appropriately.
  *
- * @package    core
- * @subpackage role
+ * @package    core_access
  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -155,11 +159,11 @@ define('CONTEXT_BLOCK', 80);
 define('RISK_MANAGETRUST', 0x0001);
 /** Capability allows changes in system configuration - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
 define('RISK_CONFIG',      0x0002);
-/** Capability allows user to add scritped content - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
+/** Capability allows user to add scripted content - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
 define('RISK_XSS',         0x0004);
 /** Capability allows access to personal user information - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
 define('RISK_PERSONAL',    0x0008);
-/** Capability allows users to add content otehrs may see - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
+/** Capability allows users to add content others may see - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
 define('RISK_SPAM',        0x0010);
 /** capability allows mass delete of data belonging to other users - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
 define('RISK_DATALOSS',    0x0020);
@@ -177,8 +181,8 @@ define('ROLENAME_ALIAS_RAW', 4);
 /** rolename displays - the name is simply short role name */
 define('ROLENAME_SHORT', 5);
 
-/** maximum size of context cache - it is possible to tweak this config.php or in any script before inclusion of context.php */
 if (!defined('CONTEXT_CACHE_MAX_SIZE')) {
+    /** maximum size of context cache - it is possible to tweak this config.php or in any script before inclusion of context.php */
     define('CONTEXT_CACHE_MAX_SIZE', 2500);
 }
 
@@ -190,7 +194,7 @@ if (!defined('CONTEXT_CACHE_MAX_SIZE')) {
  * Sadly, a PHP global variable is the only way to implement this, without rewriting everything
  * as methods of a class, instead of functions.
  *
- * @private
+ * @access private
  * @global stdClass $ACCESSLIB_PRIVATE
  * @name $ACCESSLIB_PRIVATE
  */
@@ -208,6 +212,7 @@ $ACCESSLIB_PRIVATE->capabilities     = null;    // detailed information about th
  * accesslib's private caches. You need to do this before setting up test data,
  * and also at the end of the tests.
  *
+ * @access private
  * @return void
  */
 function accesslib_clear_all_caches_for_unit_testing() {
@@ -226,7 +231,7 @@ function accesslib_clear_all_caches_for_unit_testing() {
  *
  * This reset does not touch global $USER.
  *
- * @private
+ * @access private
  * @param bool $resetcontexts
  * @return void
  */
@@ -246,7 +251,7 @@ function accesslib_clear_all_caches($resetcontexts) {
 /**
  * Gets the accessdata for role "sitewide" (system down to course)
  *
- * @private
+ * @access private
  * @param int $roleid
  * @return array
  */
@@ -330,8 +335,8 @@ function get_guest_role() {
  * Check whether a user has a particular capability in a given context.
  *
  * For example:
- *      $context = get_context_instance(CONTEXT_MODULE, $cm->id);
- *      has_capability('mod/forum:replypost',$context)
+ *      $context = context_module::instance($cm->id);
+ *      has_capability('mod/forum:replypost', $context)
  *
  * By default checks the capabilities of the current user, but you can pass a
  * different userid. By default will return true for admin users, but you can override that with the fourth argument.
@@ -339,9 +344,11 @@ function get_guest_role() {
  * Guest and not-logged-in users can never get any dangerous capability - that is any write capability
  * or capabilities with XSS, config or data loss risks.
  *
+ * @category access
+ *
  * @param string $capability the name of the capability to check. For example mod/forum:view
- * @param context $context the context to check the capability in. You normally get this with {@link get_context_instance}.
- * @param integer|object $user A user id or object. By default (null) checks the permissions of the current user.
+ * @param context $context the context to check the capability in. You normally get this with instance method of a context class.
+ * @param integer|stdClass $user A user id or object. By default (null) checks the permissions of the current user.
  * @param boolean $doanything If false, ignores effect of admin role assignment
  * @return boolean true if the user has this capability. Otherwise false.
  */
@@ -482,16 +489,18 @@ function has_capability($capability, context $context, $user = null, $doanything
  * the capabilities that most users are likely to have first in the list for best
  * performance.
  *
+ * @category access
  * @see has_capability()
+ *
  * @param array $capabilities an array of capability names.
- * @param context $context the context to check the capability in. You normally get this with {@link get_context_instance}.
- * @param integer $userid A user id. By default (null) checks the permissions of the current user.
+ * @param context $context the context to check the capability in. You normally get this with instance method of a context class.
+ * @param integer|stdClass $user A user id or object. By default (null) checks the permissions of the current user.
  * @param boolean $doanything If false, ignore effect of admin role assignment
  * @return boolean true if the user has any of these capabilities. Otherwise false.
  */
-function has_any_capability(array $capabilities, context $context, $userid = null, $doanything = true) {
+function has_any_capability(array $capabilities, context $context, $user = null, $doanything = true) {
     foreach ($capabilities as $capability) {
-        if (has_capability($capability, $context, $userid, $doanything)) {
+        if (has_capability($capability, $context, $user, $doanything)) {
             return true;
         }
     }
@@ -505,16 +514,18 @@ function has_any_capability(array $capabilities, context $context, $userid = nul
  * the capabilities that fewest users are likely to have first in the list for best
  * performance.
  *
+ * @category access
  * @see has_capability()
+ *
  * @param array $capabilities an array of capability names.
- * @param context $context the context to check the capability in. You normally get this with {@link get_context_instance}.
- * @param integer $userid A user id. By default (null) checks the permissions of the current user.
+ * @param context $context the context to check the capability in. You normally get this with instance method of a context class.
+ * @param integer|stdClass $user A user id or object. By default (null) checks the permissions of the current user.
  * @param boolean $doanything If false, ignore effect of admin role assignment
  * @return boolean true if the user has all of these capabilities. Otherwise false.
  */
-function has_all_capabilities(array $capabilities, context $context, $userid = null, $doanything = true) {
+function has_all_capabilities(array $capabilities, context $context, $user = null, $doanything = true) {
     foreach ($capabilities as $capability) {
-        if (!has_capability($capability, $context, $userid, $doanything)) {
+        if (!has_capability($capability, $context, $user, $doanything)) {
             return false;
         }
     }
@@ -527,6 +538,8 @@ function has_all_capabilities(array $capabilities, context $context, $userid = n
  * Please note that use of proper capabilities is always encouraged,
  * this function is supposed to be used from core or for temporary hacks.
  *
+ * @category access
+ *
  * @param  int|stdClass  $user_or_id user id or user object
  * @return bool true if user is one of the administrators, false otherwise
  */
@@ -597,7 +610,7 @@ function has_coursecontact_role($userid) {
  * and then verify if user has at least one role with allow
  * and at the same time no role with prohibit.
  *
- * @private
+ * @access private
  * @param string $capability
  * @param context $context
  * @param array $accessdata
@@ -703,7 +716,7 @@ function require_capability($capability, context $context, $userid = null, $doan
  * [ra]   => [/path][roleid]=roleid
  * [rdef] => [/path:roleid][capability]=permission
  *
- * @private
+ * @access private
  * @param int $userid - the id of the user
  * @return array access info array
  */
@@ -817,7 +830,7 @@ function get_user_access_sitewide($userid) {
  *
  * This function injects all course related access info into the accessdata array.
  *
- * @private
+ * @access private
  * @param int $userid the id of the user
  * @param context_course $coursecontext course context
  * @param array $accessdata accessdata array (modified)
@@ -937,7 +950,7 @@ function load_course_context($userid, context_course $coursecontext, &$accessdat
  * This role-centric function is useful for role_switching
  * and temporary course roles.
  *
- * @private
+ * @access private
  * @param int $roleid the id of the user
  * @param context $context needs path!
  * @param array $accessdata accessdata array (is modified)
@@ -991,7 +1004,7 @@ function load_role_access_by_context($roleid, context $context, &$accessdata) {
 /**
  * Returns empty accessdata structure.
  *
- * @private
+ * @access private
  * @return array empt accessdata
  */
 function get_empty_accessdata() {
@@ -1010,7 +1023,7 @@ function get_empty_accessdata() {
 /**
  * Get accessdata for a given user.
  *
- * @private
+ * @access private
  * @param int $userid
  * @param bool $preloadonly true means do not return access array
  * @return array accessdata
@@ -1061,7 +1074,7 @@ function get_user_accessdata($userid, $preloadonly=false) {
  * Try to minimise the size of $USER->access by eliminating duplicate override storage,
  * this function looks for contexts with the same overrides and shares them.
  *
- * @private
+ * @access private
  * @return void
  */
 function dedupe_user_access() {
@@ -1103,7 +1116,7 @@ function dedupe_user_access() {
  * Call it only _after_ you've setup $USER and called check_enrolment_plugins();
  * @see check_enrolment_plugins()
  *
- * @private
+ * @access private
  * @return void
  */
 function load_all_capabilities() {
@@ -1142,7 +1155,7 @@ function load_all_capabilities() {
  *
  * Note: reloads $USER->access completely.
  *
- * @private
+ * @access private
  * @return void
  */
 function reload_all_capabilities() {
@@ -1172,8 +1185,9 @@ function reload_all_capabilities() {
  * Adds a temp role to current USER->access array.
  *
  * Useful for the "temporary guest" access we grant to logged-in users.
- * @since 2.2
+ * This is useful for enrol plugins only.
  *
+ * @since 2.2
  * @param context_course $coursecontext
  * @param int $roleid
  * @return void
@@ -1211,8 +1225,9 @@ function load_temp_course_role(context_course $coursecontext, $roleid) {
 
 /**
  * Removes any extra guest roles from current USER->access array.
- * @since 2.2
+ * This is useful for enrol plugins only.
  *
+ * @since 2.2
  * @param context_course $coursecontext
  * @return void
  */
@@ -1303,7 +1318,7 @@ function assign_legacy_capabilities($capability, $legacyperms) {
 /**
  * Verify capability risks.
  *
- * @param object $capability a capability - a row from the capabilities table.
+ * @param stdClass $capability a capability - a row from the capabilities table.
  * @return boolean whether this capability is safe - that is, whether people with the
  *      safeoverrides capability should be allowed to change it.
  */
@@ -1514,10 +1529,10 @@ function unassign_capability($capability, $roleid, $contextid = null) {
  * It just checks for permissions and overrides.
  * Use get_roles_with_cap_in_context() if resolution is required.
  *
- * @param string $capability capability name (string)
- * @param string $permission optional, the permission defined for this capability
+ * @param string $capability capability name (string)
+ * @param string $permission optional, the permission defined for this capability
  *                      either CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT. Defaults to null which means any.
- * @param stdClass $context, null means any
+ * @param stdClass $context null means any
  * @return array of role records
  */
 function get_roles_with_capability($capability, $permission = null, $context = null) {
@@ -1730,7 +1745,7 @@ function role_unassign_all(array $params, $subcontexts = false, $includemanual =
         if ($context = context::instance_by_id($ra->contextid, IGNORE_MISSING)) {
             // this is a bit expensive but necessary
             $context->mark_dirty();
-            /// If the user is the current user, then do full reload of capabilities too.
+            // If the user is the current user, then do full reload of capabilities too.
             if (!empty($USER->id) && $USER->id == $ra->userid) {
                 reload_all_capabilities();
             }
@@ -1757,7 +1772,7 @@ function role_unassign_all(array $params, $subcontexts = false, $includemanual =
                     $DB->delete_records('role_assignments', array('id'=>$ra->id));
                     // this is a bit expensive but necessary
                     $context->mark_dirty();
-                    /// If the user is the current user, then do full reload of capabilities too.
+                    // If the user is the current user, then do full reload of capabilities too.
                     if (!empty($USER->id) && $USER->id == $ra->userid) {
                         reload_all_capabilities();
                     }
@@ -1777,6 +1792,8 @@ function role_unassign_all(array $params, $subcontexts = false, $includemanual =
 /**
  * Determines if a user is currently logged in
  *
+ * @category   access
+ *
  * @return bool
  */
 function isloggedin() {
@@ -1788,6 +1805,8 @@ function isloggedin() {
 /**
  * Determines if a user is logged in as real guest user with username 'guest'.
  *
+ * @category   access
+ *
  * @param int|object $user mixed user object or id, $USER if not specified
  * @return bool true if user is the real guest user, false if not logged in or other user
  */
@@ -1828,6 +1847,8 @@ function isguestuser($user = null) {
 /**
  * Does user have a (temporary or real) guest access to course?
  *
+ * @category   access
+ *
  * @param context $context
  * @param stdClass|int $user
  * @return bool
@@ -1867,8 +1888,10 @@ function is_guest(context $context, $user = null) {
  * Returns true if the user has moodle/course:view capability in the course,
  * this is intended for admins, managers (aka small admins), inspectors, etc.
  *
+ * @category   access
+ *
  * @param context $context
- * @param int|stdClass $user, if null $USER is used
+ * @param int|stdClass $user if null $USER is used
  * @param string $withcapability extra capability name
  * @return bool
  */
@@ -1900,8 +1923,11 @@ function is_viewing(context $context, $user = null, $withcapability = '') {
  *
  * Since 2.2 the result for active enrolments and current user are cached.
  *
+ * @package   core_enrol
+ * @category  access
+ *
  * @param context $context
- * @param int|stdClass $user, if null $USER is used, otherwise user object or id expected
+ * @param int|stdClass $user if null $USER is used, otherwise user object or id expected
  * @param string $withcapability extra capability name
  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
  * @return bool
@@ -2102,6 +2128,9 @@ function can_access_course(stdClass $course, $user = null, $withcapability = '',
  *
  * This function is using 'eu[0-9]+_' prefix for table names and parameters.
  *
+ * @package   core_enrol
+ * @category  access
+ *
  * @param context $context
  * @param string $withcapability
  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
@@ -2265,6 +2294,9 @@ function get_enrolled_sql(context $context, $withcapability = '', $groupid = 0,
 /**
  * Returns list of users enrolled into course.
  *
+ * @package   core_enrol
+ * @category  access
+ *
  * @param context $context
  * @param string $withcapability
  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
@@ -2295,6 +2327,9 @@ function get_enrolled_users(context $context, $withcapability = '', $groupid = 0
 /**
  * Counts list of users enrolled into course (as per above function)
  *
+ * @package   core_enrol
+ * @category  access
+ *
  * @param context $context
  * @param string $withcapability
  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
@@ -2318,6 +2353,7 @@ function count_enrolled_users(context $context, $withcapability = '', $groupid =
  * Loads the capability definitions for the component (from file). If no
  * capabilities are defined for the component, we simply return an empty array.
  *
+ * @access private
  * @param string $component full plugin name, examples: 'moodle', 'mod_forum'
  * @return array array of capabilities
  */
@@ -2341,6 +2377,7 @@ function load_capability_def($component) {
 /**
  * Gets the capabilities that have been cached in the database for this component.
  *
+ * @access private
  * @param string $component - examples: 'moodle', 'mod_forum'
  * @return array array of capabilities
  */
@@ -2421,6 +2458,7 @@ function reset_role_capabilities($roleid) {
  * will cause any stored capabilities for the component to be removed from
  * the database.
  *
+ * @access private
  * @param string $component examples: 'moodle', 'mod/forum', 'block/quiz_results'
  * @return boolean true if success, exception in case of any problems
  */
@@ -2527,6 +2565,7 @@ function update_capabilities($component = 'moodle') {
  * Deletes cached capabilities that are no longer needed by the component.
  * Also unassigns these capabilities from any roles that have them.
  *
+ * @access private
  * @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
  * @param array $newcapdef array of the new capability definitions that will be
  *                     compared with the cached capabilities
@@ -2580,7 +2619,7 @@ function get_all_risks() {
 /**
  * Return a link to moodle docs for a given capability name
  *
- * @param object $capability a capability - a row from the mdl_capabilities table.
+ * @param stdClass $capability a capability - a row from the mdl_capabilities table.
  * @return string the human-readable capability name as a link to Moodle Docs.
  */
 function get_capability_docs_link($capability) {
@@ -2593,10 +2632,10 @@ function get_capability_docs_link($capability) {
  * defaults) of a role used in capability overrides in contexts at a given
  * context.
  *
- * @param context $context
  * @param int $roleid
+ * @param context $context
  * @param string $cap capability, optional, defaults to ''
- * @return array of capabilities
+ * @return array Array of capabilities
  */
 function role_context_capabilities($roleid, context $context, $cap = '') {
     global $DB;
@@ -2638,7 +2677,7 @@ function role_context_capabilities($roleid, context $context, $cap = '') {
  * Constructs array with contextids as first parameter and context paths,
  * in both cases bottom top including self.
  *
- * @private
+ * @access private
  * @param context $context
  * @return array
  */
@@ -2671,7 +2710,7 @@ function is_inside_frontpage(context $context) {
  * Returns capability information (cached)
  *
  * @param string $capabilityname
- * @return object or null if capability not found
+ * @return stdClass or null if capability not found
  */
 function get_capability_info($capabilityname) {
     global $ACCESSLIB_PRIVATE, $DB; // one request per page only
@@ -3246,6 +3285,9 @@ function get_overridable_roles(context $context, $rolenamedisplay = ROLENAME_ALI
 
 /**
  * Create a role menu suitable for default role selection in enrol plugins.
+ *
+ * @package    core_enrol
+ *
  * @param context $context
  * @param int $addroleid current or default role - always added to list
  * @return array roleid=>localised role name
@@ -3274,6 +3316,7 @@ function get_default_enrol_roles(context $context, $addroleid = null) {
 
 /**
  * Return context levels where this role is assignable.
+ *
  * @param integer $roleid the id of a role.
  * @return array list of the context levels at which this role may be assigned.
  */
@@ -3368,7 +3411,7 @@ function set_role_contextlevels($roleid, array $contextlevels) {
  *               have capability both $capability and moodle/site:accessallgroups
  *               in this context, as well as users who have $capability and who are
  *               in $groups.
- * @return mixed
+ * @return array of user records
  */
 function get_users_by_capability(context $context, $capability, $fields = '', $sort = '', $limitfrom = '', $limitnum = '',
                                  $groups = '', $exceptions = '', $doanything_ignored = null, $view_ignored = null, $useviewallgroups = false) {
@@ -3452,7 +3495,7 @@ function get_users_by_capability(context $context, $capability, $fields = '', $s
             unset($needed[$cap]);
             unset($prohibited[$cap]);
         } else if ($isfrontpage and !empty($prohibited[$cap][$defaultfrontpageroleid])) {
-            // everybody is disqualified on the frontapge
+            // everybody is disqualified on the frontpage
             unset($needed[$cap]);
             unset($prohibited[$cap]);
         }
@@ -3478,7 +3521,7 @@ function get_users_by_capability(context $context, $capability, $fields = '', $s
         unset($n);
     }
 
-    /// ***** Set up default fields ******
+    // ***** Set up default fields ******
     if (empty($fields)) {
         if ($iscoursepage) {
             $fields = 'u.*, ul.timeaccess AS lastaccess';
@@ -3491,7 +3534,7 @@ function get_users_by_capability(context $context, $capability, $fields = '', $s
         }
     }
 
-    /// Set up default sort
+    // Set up default sort
     if (empty($sort)) { // default to course lastaccess or just lastaccess
         if ($iscoursepage) {
             $sort = 'ul.timeaccess';
@@ -3516,11 +3559,11 @@ function get_users_by_capability(context $context, $capability, $fields = '', $s
         }
     }
 
-    /// We never return deleted users or guest account.
+    // We never return deleted users or guest account.
     $wherecond[] = "u.deleted = 0 AND u.id <> :guestid";
     $params['guestid'] = $CFG->siteguest;
 
-    /// Groups
+    // Groups
     if ($groups) {
         $groups = (array)$groups;
         list($grouptest, $grpparams) = $DB->get_in_or_equal($groups, SQL_PARAMS_NAMED, 'grp');
@@ -3539,7 +3582,7 @@ function get_users_by_capability(context $context, $capability, $fields = '', $s
         }
     }
 
-    /// User exceptions
+    // User exceptions
     if (!empty($exceptions)) {
         $exceptions = (array)$exceptions;
         list($exsql, $exparams) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'exc', false);
@@ -3613,7 +3656,7 @@ function get_users_by_capability(context $context, $capability, $fields = '', $s
     }
     $joins = implode("\n", $joins);
 
-    /// Ok, let's get the users!
+    // Ok, let's get the users!
     $sql = "SELECT $fields
               FROM {user} u
             $joins
@@ -3963,7 +4006,7 @@ function role_switch($roleid, context $context) {
 /**
  * Checks if the user has switched roles within the given course.
  *
- * Note: You can only switch roles within the course, hence it takes a courseid
+ * Note: You can only switch roles within the course, hence it takes a course id
  * rather than a context. On that note Petr volunteered to implement this across
  * all other contexts, all requests for this should be forwarded to him ;)
  *
@@ -4095,7 +4138,7 @@ function role_get_name($role, context_course $coursecontext) {
  * @param array $roleoptions array roleid => rolename or roleid => roleobject
  * @param context $context a context
  * @param int $rolenamedisplay
- * @return array Array of context-specific role names, or role objexts with a ->localname field added.
+ * @return array Array of context-specific role names, or role objects with a ->localname field added.
  */
 function role_fix_names($roleoptions, context $context, $rolenamedisplay = ROLENAME_ALIAS) {
     global $DB;
@@ -4214,8 +4257,8 @@ function fix_role_sortorder($allroles) {
 /**
  * Switch the sort order of two roles (used in admin/roles/manage.php).
  *
- * @param object $first The first role. Actually, only ->sortorder is used.
- * @param object $second The second role. Actually, only ->sortorder is used.
+ * @param stdClass $first The first role. Actually, only ->sortorder is used.
+ * @param stdClass $second The second role. Actually, only ->sortorder is used.
  * @return boolean success or failure
  */
 function switch_roles($first, $second) {
@@ -4230,7 +4273,7 @@ function switch_roles($first, $second) {
 /**
  * Duplicates all the base definitions of a role
  *
- * @param object $sourcerole role to copy from
+ * @param stdClass $sourcerole role to copy from
  * @param int $targetrole id of role to copy to
  */
 function role_cap_duplicate($sourcerole, $targetrole) {
@@ -4255,7 +4298,7 @@ function role_cap_duplicate($sourcerole, $targetrole) {
  * user has this capability in this context.
  * Use get_role_names_with_cap_in_context() if you need role names to display in the UI
  *
- * @param object $context
+ * @param stdClass $context
  * @param string $capability
  * @return array($neededroles, $forbiddenroles)
  */
@@ -4314,7 +4357,7 @@ function get_roles_with_cap_in_context($context, $capability) {
  * Returns an array of role IDs that have ALL of the the supplied capabilities
  * Uses get_roles_with_cap_in_context(). Returns $allowed minus $forbidden
  *
- * @param object $context
+ * @param stdClass $context
  * @param array $capabilities An array of capabilities
  * @return array of roles with all of the required capabilities
  */
@@ -4349,7 +4392,7 @@ function get_roles_with_caps_in_context($context, $capabilities) {
  * Returns an array of role names that have ALL of the the supplied capabilities
  * Uses get_roles_with_caps_in_context(). Returns $allowed minus $forbidden
  *
- * @param object $context
+ * @param stdClass $context
  * @param array $capabilities An array of capabilities
  * @return array of roles with all of the required capabilities
  */
@@ -4401,7 +4444,7 @@ function prohibit_is_removable($roleid, context $context, $capability) {
     }
 
     if (count($prohibits) > 1) {
-        // more prohibints can not be removed
+        // more prohibits can not be removed
         return false;
     }
 
@@ -4411,8 +4454,9 @@ function prohibit_is_removable($roleid, context $context, $capability) {
 /**
  * More user friendly role permission changing,
  * it should produce as few overrides as possible.
+ *
  * @param int $roleid
- * @param object $context
+ * @param stdClass $context
  * @param string $capname capability name
  * @param int $permission
  * @return void
@@ -4478,39 +4522,87 @@ function role_change_permission($roleid, $context, $capname, $permission) {
 /**
  * Basic moodle context abstraction class.
  *
- * @author Petr Skoda
- * @since 2.2
+ * Google confirms that no other important framework is using "context" class,
+ * we could use something else like mcontext or moodle_context, but we need to type
+ * this very often which would be annoying and it would take too much space...
+ *
+ * This class is derived from stdClass for backwards compatibility with
+ * odl $context record that was returned from DML $DB->get_record()
+ *
+ * @package   core_access
+ * @category  access
+ * @copyright Petr Skoda {@link http://skodak.org}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since     2.2
  *
  * @property-read int $id context id
  * @property-read int $contextlevel CONTEXT_SYSTEM, CONTEXT_COURSE, etc.
  * @property-read int $instanceid id of related instance in each context
  * @property-read string $path path to context, starts with system context
- * @property-read dept $depth
+ * @property-read int $depth
  */
 abstract class context extends stdClass {
 
-    /*
-     * Google confirms that no other important framework is using "context" class,
-     * we could use something else like mcontext or moodle_context, but we need to type
-     * this very often which would be annoying and it would take too much space...
-     *
-     * This class is derived from stdClass for backwards compatibility with
-     * odl $context record that was returned from DML $DB->get_record()
+    /**
+     * The context id
+     * Can be accessed publicly through $context->id
+     * @var int
      */
-
     protected $_id;
+
+    /**
+     * The context level
+     * Can be accessed publicly through $context->contextlevel
+     * @var int One of CONTEXT_* e.g. CONTEXT_COURSE, CONTEXT_MODULE
+     */
     protected $_contextlevel;
+
+    /**
+     * Id of the item this context is related to e.g. COURSE_CONTEXT => course.id
+     * Can be accessed publicly through $context->instanceid
+     * @var int
+     */
     protected $_instanceid;
+
+    /**
+     * The path to the context always starting from the system context
+     * Can be accessed publicly through $context->path
+     * @var string
+     */
     protected $_path;
-    protected $_depth;
 
-    /* context caching info */
+    /**
+     * The depth of the context in relation to parent contexts
+     * Can be accessed publicly through $context->depth
+     * @var int
+     */
+    protected $_depth;
 
+    /**
+     * @var array Context caching info
+     */
     private static $cache_contextsbyid = array();
+
+    /**
+     * @var array Context caching info
+     */
     private static $cache_contexts     = array();
-    protected static $cache_count      = 0; // why do we do count contexts? Because count($array) is horribly slow for large arrays
 
+    /**
+     * Context count
+     * Why do we do count contexts? Because count($array) is horribly slow for large arrays
+     * @var int
+     */
+    protected static $cache_count      = 0;
+
+    /**
+     * @var array Context caching info
+     */
     protected static $cache_preloaded  = array();
+
+    /**
+     * @var context_system The system context once initialised
+     */
     protected static $systemcontext    = null;
 
     /**
@@ -4644,7 +4736,7 @@ abstract class context extends stdClass {
     /**
      * Magic setter method, we do not want anybody to modify properties from the outside
      * @param string $name
-     * @param mixed @value
+     * @param mixed $value
      */
     public function __set($name, $value) {
         debugging('Can not change context instance properties!');
@@ -4671,7 +4763,7 @@ abstract class context extends stdClass {
 
     /**
      * Full support for isset on our magic read only properties.
-     * @param $name
+     * @param string $name
      * @return bool
      */
     public function __isset($name) {
@@ -5124,7 +5216,7 @@ abstract class context extends stdClass {
      * Rebuild context paths and depths at context level.
      *
      * @static
-     * @param $force
+     * @param bool $force
      * @return void
      */
     protected static function build_paths($force) {
@@ -5216,11 +5308,17 @@ abstract class context extends stdClass {
  *
  * Thank you Tim Hunt for helping me with this nasty trick.
  *
- * @author Petr Skoda
- * @since 2.2
+ * @package   core_access
+ * @category  access
+ * @copyright Petr Skoda {@link http://skodak.org}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since     2.2
  */
 class context_helper extends context {
 
+    /**
+     * @var array An array mapping context levels to classes
+     */
     private static $alllevels = array(
             CONTEXT_SYSTEM    => 'context_system',
             CONTEXT_USER      => 'context_user',
@@ -5380,7 +5478,7 @@ class context_helper extends context {
      * To be used if you expect multiple queries for course activities...
      *
      * @static
-     * @param $courseid
+     * @param int $courseid
      */
     public static function preload_course($courseid) {
         // Users can call this multiple times without doing any harm
@@ -5440,9 +5538,13 @@ class context_helper extends context {
 
 
 /**
- * Basic context class
- * @author Petr Skoda (http://skodak.org)
- * @since 2.2
+ * System context class
+ *
+ * @package   core_access
+ * @category  access
+ * @copyright Petr Skoda {@link http://skodak.org}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since     2.2
  */
 class context_system extends context {
     /**
@@ -5648,7 +5750,7 @@ class context_system extends context {
      * Rebuild context paths and depths at system context level.
      *
      * @static
-     * @param $force
+     * @param bool $force
      */
     protected static function build_paths($force) {
         global $DB;
@@ -5678,8 +5780,12 @@ class context_system extends context {
 
 /**
  * User context class
- * @author Petr Skoda (http://skodak.org)
- * @since 2.2
+ *
+ * @package   core_access
+ * @category  access
+ * @copyright Petr Skoda {@link http://skodak.org}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since     2.2
  */
 class context_user extends context {
     /**
@@ -5829,7 +5935,7 @@ class context_user extends context {
      * Rebuild context paths and depths at user context level.
      *
      * @static
-     * @param $force
+     * @param bool $force
      */
     protected static function build_paths($force) {
         global $DB;
@@ -5846,8 +5952,12 @@ class context_user extends context {
 
 /**
  * Course category context class
- * @author Petr Skoda (http://skodak.org)
- * @since 2.2
+ *
+ * @package   core_access
+ * @category  access
+ * @copyright Petr Skoda {@link http://skodak.org}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since     2.2
  */
 class context_coursecat extends context {
     /**
@@ -6015,7 +6125,7 @@ class context_coursecat extends context {
      * Rebuild context paths and depths at course category context level.
      *
      * @static
-     * @param $force
+     * @param bool $force
      */
     protected static function build_paths($force) {
         global $DB;
@@ -6066,8 +6176,12 @@ class context_coursecat extends context {
 
 /**
  * Course context class
- * @author Petr Skoda (http://skodak.org)
- * @since 2.2
+ *
+ * @package   core_access
+ * @category  access
+ * @copyright Petr Skoda {@link http://skodak.org}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since     2.2
  */
 class context_course extends context {
     /**
@@ -6234,7 +6348,7 @@ class context_course extends context {
      * Rebuild context paths and depths at course context level.
      *
      * @static
-     * @param $force
+     * @param bool $force
      */
     protected static function build_paths($force) {
         global $DB;
@@ -6281,8 +6395,12 @@ class context_course extends context {
 
 /**
  * Course module context class
- * @author Petr Skoda (http://skodak.org)
- * @since 2.2
+ *
+ * @package   core_access
+ * @category  access
+ * @copyright Petr Skoda {@link http://skodak.org}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since     2.2
  */
 class context_module extends context {
     /**
@@ -6484,7 +6602,7 @@ class context_module extends context {
      * Rebuild context paths and depths at module context level.
      *
      * @static
-     * @param $force
+     * @param bool $force
      */
     protected static function build_paths($force) {
         global $DB;
@@ -6516,8 +6634,12 @@ class context_module extends context {
 
 /**
  * Block context class
- * @author Petr Skoda (http://skodak.org)
- * @since 2.2
+ *
+ * @package   core_access
+ * @category  access
+ * @copyright Petr Skoda {@link http://skodak.org}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since     2.2
  */
 class context_block extends context {
     /**
@@ -6697,7 +6819,7 @@ class context_block extends context {
      * Rebuild context paths and depths at block context level.
      *
      * @static
-     * @param $force
+     * @param bool $force
      */
     protected static function build_paths($force) {
         global $DB;
@@ -6756,7 +6878,7 @@ function load_temp_role($context, $roleid, array $accessdata) {
  * Not available any more, use remove_temp_course_roles() instead.
  *
  * @deprecated since 2.2
- * @param object $context
+ * @param stdClass $context
  * @param array $accessdata
  * @return array access data
  */
@@ -6863,7 +6985,7 @@ function get_parent_contextid(context $context) {
  * contexts ;-)
  *
  * @deprecated since 2.2, use $context->get_child_contexts() instead
- * @param context $context.
+ * @param context $context
  * @return array Array of child records
  */
 function get_child_contexts(context $context) {
@@ -6907,7 +7029,7 @@ function build_context_path($force = false) {
 /**
  * Rebuild all related context depth and path caches
  *
- * @deprecated
+ * @deprecated since 2.2
  * @param array $fixcontexts array of contexts, strongtyped
  * @return void
  */
@@ -6935,7 +7057,7 @@ function preload_course_contexts($courseid) {
  * Preloads context information together with instances.
  * Use context_instance_preload() to strip the context info from the record and cache the context instance.
  *
- * @deprecated
+ * @deprecated since 2.2
  * @param string $joinon for example 'u.id'
  * @param string $contextlevel context level of instance in $joinon
  * @param string $tablealias context table alias
@@ -7037,6 +7159,7 @@ function delete_context($contextlevel, $instanceid, $deleterecord = true) {
 
 /**
  * Returns context level name
+ *
  * @deprecated since 2.2
  * @param integer $contextlevel $context->context level. One of the CONTEXT_... constants.
  * @return string the name for this type of context.
index ae5ca8e..8fe0b86 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -43,8 +42,8 @@
  *
  * The variable name for the capability definitions array is $capabilities
  *
- * @package    core
- * @subpackage role
+ * @package    core_access
+ * @category   access
  * @copyright  2006 onwards Martin Dougiamas  http://dougiamas.com
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index e6c52d5..768691b 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Definition of core event handler
- * and description of all events throws from core.
+ * Definition of core event handler and description of all events throws from core.
  *
- * @package    core
- * @subpackage event
- * @copyright  2007 onwards Martin Dougiamas  http://dougiamas.com
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package core
+ * @category event
+ * @copyright 2007 onwards Martin Dougiamas  http://dougiamas.com
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
index bc08fb9..f34e835 100644 (file)
@@ -313,7 +313,7 @@ class oci_native_moodle_database extends moodle_database {
         if (preg_match_all('/\{([a-z][a-z0-9_]*)\}/', $sql, $matches)) {
             foreach($matches[0] as $key=>$match) {
                 $name = $matches[1][$key];
-                if ($this->temptables->is_temptable($name)) {
+                if ($this->temptables && $this->temptables->is_temptable($name)) {
                     $sql = str_replace($match, $this->temptables->get_correct_name($name), $sql);
                 } else {
                     $sql = str_replace($match, $this->prefix.$name, $sql);
index 6ceaf5e..2837488 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
  *
  * The public API is all at the end of this file.
  *
- * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @package    core
- * @subpackage event
+ * @package core
+ * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
@@ -32,10 +30,10 @@ defined('MOODLE_INTERNAL') || die();
  * Loads the events definitions for the component (from file). If no
  * events are defined for the component, we simply return an empty array.
  *
- * INTERNAL - to be used from eventslib only
+ * @access protected To be used from eventslib only
  *
  * @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
- * @return array of capabilities or empty array if not exists
+ * @return array Array of capabilities or empty array if not exists
  */
 function events_load_def($component) {
     global $CFG;
@@ -94,7 +92,7 @@ function events_load_def($component) {
  * Gets the capabilities that have been cached in the database for this
  * component.
  *
- * INTERNAL - to be used from eventslib only
+ * @access protected To be used from eventslib only
  *
  * @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
  * @return array of events
@@ -119,13 +117,17 @@ function events_get_cached($component) {
 }
 
 /**
- * We can not removed all event handlers in table, then add them again
- * because event handlers could be referenced by queued items
+ * Updates all of the event definitions within the database.
+ *
+ * Unfortunately this isn't as simple as removing them all and then readding
+ * the updated event definitions. Chances are queued items are referencing the
+ * existing definitions.
  *
  * Note that the absence of the db/events.php event definition file
  * will cause any queued events for the component to be removed from
  * the database.
  *
+ * @category event
  * @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
  * @return boolean always returns true
  */
@@ -194,6 +196,7 @@ function events_update_definition($component='moodle') {
 /**
  * Remove all event handlers and queued events
  *
+ * @category event
  * @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
  */
 function events_uninstall($component) {
@@ -206,7 +209,7 @@ function events_uninstall($component) {
 /**
  * Deletes cached events that are no longer needed by the component.
  *
- * INTERNAL - to be used from eventslib only
+ * @access protected To be used from eventslib only
  *
  * @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
  * @param array $cachedhandlers array of the cached events definitions that will be
@@ -233,14 +236,14 @@ function events_cleanup($component, $cachedhandlers) {
 /****************** End of Events handler Definition code *******************/
 
 /**
- * puts a handler on queue
+ * Puts a handler on queue
  *
- * INTERNAL - to be used from eventslib only
+ * @access protected To be used from eventslib only
  *
- * @param object $handler event handler object from db
- * @param object $event event data object
+ * @param stdClass $handler event handler object from db
+ * @param stdClass $event event data object
  * @param string $errormessage The error message indicating the problem
- * @return id number of new queue handler
+ * @return int id number of new queue handler
  */
 function events_queue_handler($handler, $event, $errormessage) {
     global $DB;
@@ -268,12 +271,12 @@ function events_queue_handler($handler, $event, $errormessage) {
 /**
  * trigger a single event with a specified handler
  *
- * INTERNAL - to be used from eventslib only
+ * @access protected To be used from eventslib only
  *
- * @param handler $hander object from db
- * @param eventdata $eventdata dataobject
+ * @param stdClass $handler This shoudl be a row from the events_handlers table.
+ * @param stdClass $eventdata An object containing information about the event
  * @param string $errormessage error message indicating problem
- * @return bool true means event processed, false means retry event later; may throw exception, NULL means internal error
+ * @return bool|null True means event processed, false means retry event later; may throw exception, NULL means internal error
  */
 function events_dispatch($handler, $eventdata, &$errormessage) {
     global $CFG;
@@ -309,9 +312,9 @@ function events_dispatch($handler, $eventdata, &$errormessage) {
 /**
  * given a queued handler, call the respective event handler to process the event
  *
- * INTERNAL - to be used from eventslib only
+ * @access protected To be used from eventslib only
  *
- * @param object $qhandler events_queued_handler object from db
+ * @param stdClass $qhandler events_queued_handler row from db
  * @return boolean true means event processed, false means retry later, NULL means fatal failure
  */
 function events_process_queued_handler($qhandler) {
@@ -368,9 +371,9 @@ function events_process_queued_handler($qhandler) {
  *
  * Removes events_queue record from events_queue if no more references to this event object exists
  *
- * INTERNAL - to be used from eventslib only
+ * @access protected To be used from eventslib only
  *
- * @param object $qhandler events_queued_handler object from db
+ * @param stdClass $qhandler A row from the events_queued_handler table
  */
 function events_dequeue($qhandler) {
     global $DB;
@@ -387,11 +390,11 @@ function events_dequeue($qhandler) {
 /**
  * Returns handlers for given event. Uses caching for better perf.
  *
- * INTERNAL - to be used from eventslib only
+ * @access protected To be used from eventslib only
  *
  * @staticvar array $handlers
- * @param string $eventanme name of even or 'reset'
- * @return mixed array of handlers or false otherwise
+ * @param string $eventname name of event or 'reset'
+ * @return array|false array of handlers or false otherwise
  */
 function events_get_handlers($eventname) {
     global $DB;
@@ -409,16 +412,13 @@ function events_get_handlers($eventname) {
     return $handlers[$eventname];
 }
 
-/****** Public events API starts here, do not use functions above in 3rd party code ******/
-
-
 /**
  * Events cron will try to empty the events queue by processing all the queued events handlers
  *
- * PUBLIC
- *
+ * @access public Part of the public API
+ * @category event
  * @param string $eventname empty means all
- * @return number of dispatched events
+ * @return int number of dispatched events
  */
 function events_cron($eventname='') {
     global $DB;
@@ -477,10 +477,11 @@ function events_cron($eventname='') {
 /**
  * Function to call all event handlers when triggering an event
  *
- * PUBLIC
- *
+ * @access public Part of the public API.
+ * @category event
  * @param string $eventname name of the event
- * @param object $eventdata event data object
+ * @param string $eventdata event data object. This should contain any data the
+ *     event wants to share and should really be documented by the event publisher
  * @return int number of failed events
  */
 function events_trigger($eventname, $eventdata) {
@@ -586,6 +587,8 @@ function events_trigger($eventname, $eventdata) {
 /**
  * checks if an event is registered for this component
  *
+ * @access public Part of the public API
+ *
  * @param string $eventname name of the event
  * @param string $component component name, can be mod/data or moodle
  * @return bool
@@ -598,7 +601,7 @@ function events_is_registered($eventname, $component) {
 /**
  * checks if an event is queued for processing - either cron handlers attached or failed instant handlers
  *
- * PUBLIC
+ * @access public Part of the public API
  *
  * @param string $eventname name of the event
  * @return int number of queued events
@@ -612,4 +615,4 @@ function events_pending_count($eventname) {
              WHERE h.eventname = ?";
 
     return $DB->count_records_sql($sql, array($eventname));
-}
+}
\ No newline at end of file
index 298811a..2b1a83d 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
 /**
  * Utility class for browsing of files.
  *
- * @package    core
- * @subpackage filebrowser
- * @copyright  2008 Petr Skoda (http://skodak.org)
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @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();
@@ -41,8 +39,7 @@ require_once("$CFG->libdir/filebrowser/file_info_context_course.php");
 require_once("$CFG->libdir/filebrowser/file_info_context_module.php");
 
 /**
- * This class provides the main entry point for other code wishing to get
- * information about files.
+ * This class provides the main entry point for other code wishing to get information about files.
  *
  * The whole file storage for a Moodle site can be seen as a huge virtual tree.
  * The spine of the tree is the tree of contexts (system, course-categories,
@@ -56,22 +53,23 @@ require_once("$CFG->libdir/filebrowser/file_info_context_module.php");
  *
  * Always use this abstraction when you need to access module files from core code.
   *
- * @package    core
- * @subpackage filebrowser
- * @copyright  2008 Petr Skoda (http://skodak.org)
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package   core_files
+ * @category  files
+ * @copyright 2008 Petr Skoda (http://skodak.org)
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
 class file_browser {
 
     /**
      * Looks up file_info instance
-     * @param object $context
-     * @param string $component
-     * @param string $filearea
-     * @param int $itemid
-     * @param string $filepath
-     * @param string $filename
-     * @return file_info instance or null if not found or access not allowed
+     *
+     * @param stdClass $context context object
+     * @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 file_info|null file_info instance or null if not found or access not allowed
      */
     public function get_file_info($context = NULL, $component = NULL, $filearea = NULL, $itemid = NULL, $filepath = NULL, $filename = NULL) {
         if (!$context) {
@@ -95,12 +93,13 @@ class file_browser {
 
     /**
      * Returns info about the files at System context
-     * @param object $context
-     * @param string $component
-     * @param string $filearea
-     * @param int $itemid
-     * @param string $filepath
-     * @param string $filename
+     *
+     * @param object $context context object
+     * @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 file_info instance or null if not found or access not allowed
      */
     private function get_file_info_context_system($context, $component, $filearea, $itemid, $filepath, $filename) {
@@ -111,13 +110,14 @@ class file_browser {
 
     /**
      * Returns info about the files at User context
-     * @param object $context
-     * @param string $component
-     * @param string $filearea
-     * @param int $itemid
-     * @param string $filepath
-     * @param string $filename
-     * @return file_info instance or null if not found or access not allowed
+     *
+     * @param stdClass $context context object
+     * @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 file_info|null file_info instance or null if not found or access not allowed
      */
     private function get_file_info_context_user($context, $component, $filearea, $itemid, $filepath, $filename) {
         global $DB, $USER;
@@ -142,13 +142,14 @@ class file_browser {
 
     /**
      * Returns info about the files at Course category context
-     * @param object $context
-     * @param string $component
-     * @param string $filearea
-     * @param int $itemid
-     * @param string $filepath
-     * @param string $filename
-     * @return file_info instance or null if not found or access not allowed
+     *
+     * @param stdClass $context context object
+     * @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 file_info|null file_info instance or null if not found or access not allowed
      */
     private function get_file_info_context_coursecat($context, $component, $filearea, $itemid, $filepath, $filename) {
         global $DB;
@@ -163,13 +164,14 @@ class file_browser {
 
     /**
      * Returns info about the files at Course category context
-     * @param object $context
-     * @param string $component
-     * @param string $filearea
-     * @param int $itemid
-     * @param string $filepath
-     * @param string $filename
-     * @return file_info instance or null if not found or access not allowed
+     *
+     * @param stdClass $context context object
+     * @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 file_info|null file_info instance or null if not found or access not allowed
      */
     private function get_file_info_context_course($context, $component, $filearea, $itemid, $filepath, $filename) {
         global $DB, $COURSE;
@@ -186,13 +188,14 @@ class file_browser {
 
     /**
      * Returns info about the files at Course category context
-     * @param object $context
-     * @param string $component
-     * @param string $filearea
-     * @param int $itemid
-     * @param string $filepath
-     * @param string $filename
-     * @return file_info instance or null if not found or access not allowed
+     *
+     * @param stdClass $context context object
+     * @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 file_info|null file_info instance or null if not found or access not allowed
      */
     private function get_file_info_context_module($context, $component, $filearea, $itemid, $filepath, $filename) {
         global $COURSE, $DB, $CFG;
index 52ba8b1..4406911 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -19,8 +18,7 @@
 /**
  * Base for all file browsing classes.
  *
- * @package    core
- * @subpackage filebrowser
+ * @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 @see{file_browser}.
+ * Base class for things in the tree navigated by {@link file_browser}.
  *
- * @package    core
- * @subpackage filebrowser
+ * @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;
@@ -50,6 +55,7 @@ abstract class file_info {
      * 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() {
@@ -63,30 +69,35 @@ abstract class file_info {
 
     /**
      * Returns localised visible name.
+     *
      * @return string
      */
     public abstract function get_visible_name();
 
     /**
-     * Is directory?
+     * 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() {
@@ -104,8 +115,9 @@ abstract class file_info {
 
     /**
      * Returns file download url
-     * @param bool $forcedownload
-     * @param bool $htts force https
+     *
+     * @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) {
@@ -113,7 +125,8 @@ abstract class file_info {
     }
 
     /**
-     * Can I read content of this file or enter directory?
+     * Whether or not I can read content of this file or enter directory
+     *
      * @return bool
      */
     public function is_readable() {
@@ -121,7 +134,8 @@ abstract class file_info {
     }
 
     /**
-     * Can I add new files or directories?
+     * Whether or not new files or directories can be added
+     *
      * @return bool
      */
     public function is_writable() {
@@ -143,6 +157,7 @@ abstract class file_info {
 
     /**
      * Returns file size in bytes, null for directories
+     *
      * @return int bytes or null if not known
      */
     public function get_filesize() {
@@ -151,6 +166,7 @@ abstract class file_info {
 
     /**
      * Returns mimetype
+     *
      * @return string mimetype or null if not known
      */
     public function get_mimetype() {
@@ -159,6 +175,7 @@ abstract class file_info {
 
     /**
      * Returns time created unix timestamp if known
+     *
      * @return int timestamp or null
      */
     public function get_timecreated() {
@@ -167,6 +184,7 @@ abstract class file_info {
 
     /**
      * Returns time modified unix timestamp if known
+     *
      * @return int timestamp or null
      */
     public function get_timemodified() {
@@ -183,6 +201,7 @@ abstract class file_info {
 
     /**
      * Returns the author name of the file
+     *
      * @return string author name or null
      */
     public function get_author() {
@@ -191,6 +210,7 @@ abstract class file_info {
 
     /**
      * Returns the source of the file
+     *
      * @return string a source url or null
      */
     public function get_source() {
@@ -199,6 +219,7 @@ abstract class file_info {
 
     /**
      * Returns the sort order of the file
+     *
      * @return int
      */
     public function get_sortorder() {
@@ -208,8 +229,9 @@ abstract class file_info {
     /**
      * Create new directory, may throw exception - make sure
      * params are valid.
+     *
      * @param string $newdirname name of new directory
-     * @param int id of author, default $USER->id
+     * @param int $userid id of author, default $USER->id
      * @return file_info new directory
      */
     public function create_directory($newdirname, $userid = NULL) {
@@ -219,9 +241,10 @@ abstract class file_info {
     /**
      * Create new file from string - make sure
      * params are valid.
+     *
      * @param string $newfilename name of new file
      * @param string $content of file
-     * @param int id of author, default $USER->id
+     * @param int $userid id of author, default $USER->id
      * @return file_info new file
      */
     public function create_file_from_string($newfilename, $content, $userid = NULL) {