Merge branch 'master' of https://github.com/moodle/moodle
authorPaul Charsley <p.charsley@massey.ac.nz>
Sun, 26 Feb 2012 21:47:35 +0000 (10:47 +1300)
committerPaul Charsley <p.charsley@massey.ac.nz>
Sun, 26 Feb 2012 21:47:35 +0000 (10:47 +1300)
292 files changed:
admin/mnet/peer_forms.php
admin/settings/grades.php
admin/tool/customlang/lang/en/tool_customlang.php
backup/cc/cc_includes.php
backup/cc/cc_lib/cc_asssesment.php
backup/cc/cc_lib/cc_basiclti.php
backup/cc/cc_lib/cc_convert_moodle2.php
backup/cc/cc_lib/cc_converter_label.php [new file with mode: 0644]
backup/cc/cc_lib/cc_forum.php
backup/cc/cc_lib/cc_page.php
backup/cc/cc_lib/cc_resources.php
backup/cc/cc_lib/cc_weblink.php
backup/cc/cc_lib/xmlbase.php
backup/moodle2/backup_plan_builder.class.php
backup/moodle2/restore_stepslib.php
blocks/community/communitycourse.php
blocks/dock.js
blog/rsslib.php
course/publish/backup.php
enrol/ldap/lang/en/enrol_ldap.php
enrol/manual/lib.php
enrol/manual/yui/quickenrolment/quickenrolment.js
grade/edit/letter/edit_form.php
grade/edit/letter/index.php
grade/edit/letter/tabs.php
grade/edit/outcome/course.php
grade/edit/outcome/edit.php
grade/edit/outcome/edit_form.php
grade/edit/outcome/export.php
grade/edit/outcome/import.php
grade/edit/outcome/import_outcomes_form.php
grade/edit/outcome/index.php
grade/edit/outcome/tabs.php
grade/edit/scale/edit.php
grade/edit/scale/edit_form.php
grade/edit/scale/index.php
grade/edit/settings/form.php
grade/edit/settings/index.php
grade/edit/tree/action.php
grade/edit/tree/calculation.php
grade/edit/tree/calculation_form.php
grade/edit/tree/category.php
grade/edit/tree/category_form.php
grade/edit/tree/grade.php
grade/edit/tree/grade_form.php
grade/edit/tree/index.php
grade/edit/tree/item.php
grade/edit/tree/item_form.php
grade/edit/tree/lib.php
grade/edit/tree/outcomeitem.php
grade/edit/tree/outcomeitem_form.php
grade/grading/form/rubric/styles.css
grade/grading/manage.php
grade/grading/pick.php
grade/index.php
grade/lib.php
grade/querylib.php
grade/report/grader/ajax_callbacks.php
grade/report/grader/db/access.php
grade/report/grader/index.php
grade/report/grader/lang/en/gradereport_grader.php
grade/report/grader/lib.php
grade/report/grader/preferences.php
grade/report/grader/preferences_form.php
grade/report/grader/quickedit_item.php
grade/report/grader/settings.php
grade/report/grader/tabs.php
grade/report/grader/version.php
grade/report/index.php
grade/report/lib.php
grade/report/outcomes/db/access.php
grade/report/outcomes/index.php
grade/report/outcomes/lang/en/gradereport_outcomes.php
grade/report/outcomes/version.php
grade/report/overview/db/access.php
grade/report/overview/index.php
grade/report/overview/lang/en/gradereport_overview.php
grade/report/overview/lib.php
grade/report/overview/renderer.php
grade/report/overview/settings.php
grade/report/overview/version.php
grade/report/user/db/access.php
grade/report/user/index.php
grade/report/user/lang/en/gradereport_user.php
grade/report/user/lib.php
grade/report/user/renderer.php
grade/report/user/settings.php
grade/report/user/version.php
group/assign.php
group/autogroup.php
group/autogroup_form.php
group/clientlib.js
group/delete.php
group/externallib.php
group/group.php
group/group_form.php
group/grouping.php
group/grouping_form.php
group/groupings.php
group/import.php
group/import_form.php
group/index.php
group/lib.php
group/members.php
group/overview.php
group/tabs.php
install/lang/ca/error.php
install/lang/de/admin.php
install/lang/it/admin.php
install/lang/ka/moodle.php [new file with mode: 0644]
install/lang/lt/admin.php [new file with mode: 0644]
install/lang/lt/moodle.php
install/lang/lt_uni/langconfig.php [new file with mode: 0644]
lang/en/backup.php
lang/en/grades.php
lang/en/langconfig.php
lang/en/mnet.php
lib/ajax/ajaxlib.php
lib/ajax/getnavbranch.php
lib/ajax/setuserpref.php
lib/db/install.xml
lib/db/upgrade.php
lib/dml/database_column_info.php
lib/dml/moodle_database.php
lib/dml/moodle_recordset.php
lib/dml/moodle_temptables.php
lib/dml/moodle_transaction.php
lib/dml/mssql_native_moodle_database.php
lib/dml/mssql_native_moodle_recordset.php
lib/dml/mssql_native_moodle_temptables.php
lib/dml/mysqli_native_moodle_database.php
lib/dml/mysqli_native_moodle_recordset.php
lib/dml/mysqli_native_moodle_temptables.php
lib/dml/oci_native_moodle_database.php
lib/dml/oci_native_moodle_package.sql
lib/dml/oci_native_moodle_recordset.php
lib/dml/oci_native_moodle_temptables.php
lib/dml/pdo_moodle_database.php
lib/dml/pdo_moodle_recordset.php
lib/dml/pgsql_native_moodle_database.php
lib/dml/pgsql_native_moodle_recordset.php
lib/dml/pgsql_native_moodle_temptables.php
lib/dml/sqlite3_pdo_moodle_database.php
lib/dml/sqlsrv_native_moodle_database.php
lib/dml/sqlsrv_native_moodle_recordset.php
lib/dml/sqlsrv_native_moodle_temptables.php
lib/dmllib.php
lib/form/advcheckbox.php
lib/form/button.php
lib/form/cancel.php
lib/form/checkbox.php
lib/form/dateselector.php
lib/form/datetimeselector.php
lib/form/duration.php
lib/form/editor.php
lib/form/file.php
lib/form/filemanager.php
lib/form/filepicker.php
lib/form/format.php
lib/form/grading.php
lib/form/group.php
lib/form/header.php
lib/form/hidden.php
lib/form/htmleditor.php
lib/form/modgrade.php
lib/form/modvisible.php
lib/form/password.php
lib/form/passwordunmask.php
lib/form/questioncategory.php
lib/form/radio.php
lib/form/recaptcha.php
lib/form/searchableselector.php
lib/form/select.php
lib/form/selectgroups.php
lib/form/selectwithlink.php
lib/form/selectyesno.php
lib/form/simpletest/testduration.php
lib/form/static.php
lib/form/submit.php
lib/form/submitlink.php
lib/form/tags.php
lib/form/text.php
lib/form/textarea.php
lib/form/url.php
lib/form/warning.php
lib/formslib.php
lib/grade/constants.php
lib/grade/grade_category.php
lib/grade/grade_grade.php
lib/grade/grade_item.php
lib/grade/grade_object.php
lib/grade/grade_outcome.php
lib/grade/grade_scale.php
lib/grade/simpletest/testgradecategory.php
lib/grade/simpletest/testgradegrades.php
lib/grade/simpletest/testgradeitem.php
lib/grade/simpletest/testgradeoutcome.php
lib/grade/simpletest/testgradescale.php
lib/gradelib.php
lib/grouplib.php
lib/messagelib.php
lib/moodlelib.php
lib/outputactions.php
lib/outputcomponents.php
lib/outputfactories.php
lib/outputlib.php
lib/outputrenderers.php
lib/outputrequirementslib.php
lib/pagelib.php
lib/pluginlib.php
lib/rsslib.php
lib/simpletest/testmoodlelib.php
message/defaultoutputs.php
message/discussion.php
message/edit.php
message/externallib.php
message/index.php
message/lib.php
message/output/email/db/install.php
message/output/email/db/upgrade.php
message/output/email/lang/en/message_email.php
message/output/email/lib.php
message/output/email/message_output_email.php
message/output/email/settings.php
message/output/email/version.php
message/output/jabber/db/install.php
message/output/jabber/db/upgrade.php
message/output/jabber/lang/en/message_jabber.php
message/output/jabber/lib.php
message/output/jabber/message_output_jabber.php
message/output/jabber/settings.php
message/output/jabber/version.php
message/output/lib.php
message/output/popup/db/install.php
message/output/popup/db/upgrade.php
message/output/popup/lang/en/message_popup.php
message/output/popup/lib.php
message/output/popup/message_output_popup.php
message/output/popup/version.php
message/renderer.php
message/send_form.php
mnet/peer.php
mod/assignment/grade.php
mod/assignment/lib.php
mod/assignment/type/upload/assignment.class.php
mod/assignment/type/uploadsingle/assignment.class.php
mod/data/lib.php
mod/data/rsslib.php
mod/forum/lib.php
mod/forum/rsslib.php
mod/glossary/db/install.xml
mod/glossary/db/upgrade.php
mod/glossary/formats/entrylist/entrylist_format.php
mod/glossary/lang/en/glossary.php
mod/glossary/lib.php
mod/glossary/mod_form.php
mod/glossary/rsslib.php
mod/glossary/showentry.php
mod/glossary/version.php
mod/glossary/view.php
mod/lesson/backup/moodle2/restore_lesson_stepslib.php
mod/lesson/grade.php
mod/lesson/lang/en/lesson.php
mod/lesson/lib.php
mod/lesson/renderer.php
mod/lesson/styles.css
mod/lti/lib.php
mod/quiz/grade.php
mod/quiz/lib.php
mod/scorm/datamodels/debug.js.php
mod/scorm/datamodels/scorm_datamodels.js [deleted file]
mod/scorm/grade.php
mod/scorm/lang/en/scorm.php
mod/scorm/lib.php
mod/scorm/locallib.php
mod/scorm/mod_form.php
mod/scorm/module.js
mod/scorm/report/basic/report.php
mod/scorm/report/interactions/report.php
mod/scorm/styles.css
mod/workshop/lib.php
repository/filepicker.js
rss/file.php
rss/renderer.php
theme/afterburner/style/afterburner_layout.css
theme/arialist/style/settings.css
theme/standard/style/core.css
version.php
webservice/lib.php
webservice/rest/locallib.php
webservice/rest/server.php
webservice/soap/locallib.php

index 4e2e173..4c5243b 100644 (file)
@@ -98,6 +98,7 @@ class mnet_review_host_form extends moodleform {
 
         $mform->addElement('textarea', 'public_key', get_string('publickey', 'mnet'), array('rows' => 17, 'cols' => 100, 'class' => 'smalltext'));
         $mform->setType('public_key', PARAM_PEM);
+        $mform->addRule('public_key', get_string('required'), 'required');
 
         // finished with form controls, now the static informational stuff
         if ($mnet_peer && !empty($mnet_peer->bootstrapped)) {
@@ -160,7 +161,9 @@ class mnet_review_host_form extends moodleform {
         }
         $mnet_peer = new mnet_peer(); // idiotic api
         $mnet_peer->wwwroot = $data['wwwroot']; // just hard-set this rather than bootstrap the object
-        if (!$credentials = $mnet_peer->check_credentials($data['public_key'])) {
+        if (empty($data['public_key'])) {
+            $errors['public_key'] = get_string('publickeyrequired', 'mnet');
+        } else if (!$credentials = $mnet_peer->check_credentials($data['public_key'])) {
             $errmsg = '';
             foreach ($mnet_peer->error as $err) {
                 $errmsg .= $err['code'] . ': ' . $err['text'].'<br />';
index 95aee44..9915909 100644 (file)
@@ -58,6 +58,8 @@ if (has_capability('moodle/grade:manage', $systemcontext)
                                                         GRADE_NAVMETHOD_TABS => new lang_string('tabs', 'grades'),
                                                         GRADE_NAVMETHOD_COMBO => new lang_string('combo', 'grades'))));
 
+        $temp->add(new admin_setting_configcheckbox('recovergradesdefault', new lang_string('recovergradesdefault', 'grades'), new lang_string('recovergradesdefault_help', 'grades'), 0));
+
         $temp->add(new admin_setting_special_gradeexport());
 
         $temp->add(new admin_setting_special_gradelimiting());
index f8af952..c9ba4bc 100644 (file)
@@ -16,7 +16,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Strings for Language customization admin tool
+ * Strings for Language customisation admin tool
  *
  * @package    tool
  * @subpackage customlang
 
 defined('MOODLE_INTERNAL') || die();
 
-$string['checkin'] = 'Check in strings into disk';
-$string['checkout'] = 'Check out strings into the translator';
-$string['checkoutdone'] = 'Strings checked out successfully into the translator';
-$string['checkoutinprogress'] = 'Checking out strings into the translator';
-$string['confirmcheckin'] = 'You are about to check in modified strings into your local language pack. This will export the customized strings from the translator into the data directory and Moodle will start using the modified strings. Press \'Continue\' button to proceed check in.';
+$string['checkin'] = 'Save strings to language pack';
+$string['checkout'] = 'Open language pack for editing';
+$string['checkoutdone'] = 'Language pack loaded';
+$string['checkoutinprogress'] = 'Loading language pack';
+$string['confirmcheckin'] = 'You are about to save modifications to your local language pack. This will export the customised strings from the translator into you Moodle data directory and Moodle will start using the modified strings. Press \'Continue\' to proceed with saving.';
 $string['customlang:edit'] = 'Edit local translation';
 $string['customlang:view'] = 'View local translation';
 $string['filter'] = 'Filter strings';
 $string['filtercomponent'] = 'Show strings of these components';
-$string['filtercustomized'] = 'Customized only';
+$string['filtercustomized'] = 'Customised only';
 $string['filtermodified'] = 'Modified only';
 $string['filteronlyhelps'] = 'Help only';
 $string['filtershowstrings'] = 'Show strings';
 $string['filterstringid'] = 'String identifier';
 $string['filtersubstring'] = 'Only strings containing';
 $string['headingcomponent'] = 'Component';
-$string['headinglocal'] = 'Local customization';
+$string['headinglocal'] = 'Local customisation';
 $string['headingstandard'] = 'Standard text';
 $string['headingstringid'] = 'String';
-$string['markinguptodate'] = 'Marking the customization as up-to-date';
-$string['markinguptodate_help'] = 'The customized translation may get outdated if either the English original or the master translation has modified since the string was customized on your site. Review the customized translation. If you find it up-to-date, click the checkbox. Edit it otherwise.';
+$string['markinguptodate'] = 'Marking the customisation as up-to-date';
+$string['markinguptodate_help'] = 'The customised translation may get outdated if either the English original or the master translation has modified since the string was customised on your site. Review the customised translation. If you find it up-to-date, click the checkbox. Edit it otherwise.';
 $string['markuptodate'] = 'mark as up-to-date';
-$string['modifiedno'] = 'There are no modified strings to check in.';
-$string['modifiednum'] = 'There are {$a} modified strings. You must check in them into disk to store them permanently.';
+$string['modifiedno'] = 'There are no modified strings to save.';
+$string['modifiednum'] = 'There are {$a} modified strings. Do you wish to save these changes to your local language pack?';
 $string['nostringsfound'] = 'No strings found, please modify the filter settings';
 $string['placeholder'] = 'Placeholders';
 $string['placeholder_help'] = 'Placeholders are special statements like `{$a}` or `{$a->something}` within the string. They are replaced with a value when the string is actually printed.
 
 It is important to copy them exactly as they are in the original string. Do not translate them nor change their left-to-right orientation.';
 $string['placeholderwarning'] = 'string contains a placeholder';
-$string['pluginname'] = 'Language customization';
-$string['savecheckin'] = 'Save and check in strings into files';
-$string['savecontinue'] = 'Save and continue editing';
+$string['pluginname'] = 'Language customisation';
+$string['savecheckin'] = 'Save changes to the language pack';
+$string['savecontinue'] = 'Apply changes and continue editing';
index bd3369c..9b1a9bd 100644 (file)
@@ -39,4 +39,5 @@ require_once($CFG->dirroot .'/backup/cc/cc_lib/cc_converter_url.php');
 require_once($CFG->dirroot .'/backup/cc/cc_lib/cc_converter_resource.php');
 require_once($CFG->dirroot .'/backup/cc/cc_lib/cc_converter_quiz.php');
 require_once($CFG->dirroot .'/backup/cc/cc_lib/cc_converter_page.php');
+require_once($CFG->dirroot .'/backup/cc/cc_lib/cc_converter_label.php');
 require_once($CFG->dirroot .'/backup/cc/cc_lib/cc_convert_moodle2.php');
index d3d7c7b..3e3af90 100644 (file)
@@ -1821,7 +1821,7 @@ class assesment1_resurce_file extends general_cc_file {
     }
 
     public function set_title($value) {
-        $this->assessment_title = $value;
+        $this->assessment_title = self::safexml($value);
     }
 
     protected function on_save() {
index 1e2881d..d31e0b8 100644 (file)
@@ -55,10 +55,10 @@ class basicltil1_resurce_file extends general_cc_file {
     protected $cartridge_icon = null;
 
     public function set_title($title) {
-        $this->title = $title;
+        $this->title = self::safexml($title);
     }
     public function set_description($description) {
-        $this->description = $description;
+        $this->description = self::safexml($description);
     }
     public function set_launch_url ($url) {
         $this->launch_url = $url;
@@ -77,11 +77,11 @@ class basicltil1_resurce_file extends general_cc_file {
         $this->vendor = true;
     }
     public function set_vendor_name ($name) {
-        $this->vendor_name = $name;
+        $this->vendor_name = self::safexml($name);
         $this->vendor = true;
     }
     public function set_vendor_description ($desc) {
-        $this->vendor_description = $desc;
+        $this->vendor_description = self::safexml($desc);
         $this->vendor = true;
     }
     public function set_vendor_url ($url) {
index ffdc342..5f6d9e4 100644 (file)
@@ -80,9 +80,17 @@ abstract class cc_convert_moodle2 {
             if ($docp->load($moodle_backup)) {
                 //sections
                 $sections = array();
+                $coursef = new XMLGenericDocument();
+                $course_file = $dir . DIRECTORY_SEPARATOR .'course' . DIRECTORY_SEPARATOR . 'course.xml';
+                $coursef->load($course_file);
+                $numsections = (int)$coursef->nodeValue('/course/numsections');
                 $section_list = $docp->nodeList('/moodle_backup/information/contents/sections/section');
                 if (!empty($section_list)) {
+                    $count = 0;
                     foreach ($section_list as $node) {
+                        if ($count > $numsections) {
+                            break;
+                        }
                         $sectionid    = $docp->nodeValue('sectionid', $node);
                         $sectiontitle = $docp->nodeValue('title'    , $node);
                         $sectionpath  = $docp->nodeValue('directory', $node);
@@ -92,7 +100,7 @@ abstract class cc_convert_moodle2 {
                         DIRECTORY_SEPARATOR .
                         $sectionpath .
                         DIRECTORY_SEPARATOR .
-                                            'section.xml';
+                        'section.xml';
                         if ($secp->load($section_file)) {
                             $rawvalue = $secp->nodeValue('/section/sequence');
                             if ($rawvalue != '$@NULL@$') {
@@ -100,6 +108,7 @@ abstract class cc_convert_moodle2 {
                             }
                         }
                         $sections[$sectionid] = array($sectiontitle, $sequence);
+                        $count++;
                     }
                 }
                 //organization title
diff --git a/backup/cc/cc_lib/cc_converter_label.php b/backup/cc/cc_lib/cc_converter_label.php
new file mode 100644 (file)
index 0000000..21a47ae
--- /dev/null
@@ -0,0 +1,39 @@
+<?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/>.
+/**
+ * @package    backup-convert
+ * @subpackage cc-library
+ * @copyright  2012 Darko Miletic <dmiletic@moodlerooms.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require_once 'cc_converters.php';
+require_once 'cc_general.php';
+
+class cc_converter_label extends cc_converter {
+
+    public function __construct(cc_i_item &$item, cc_i_manifest &$manifest, $rootpath, $path){
+        $this->defaultfile = 'label.xml';
+        parent::__construct($item, $manifest, $rootpath, $path);
+    }
+
+    public function convert($outdir) {
+        $resitem = new cc_item();
+        $resitem->title = $this->doc->nodeValue('/activity/label/name');
+        $this->item->add_child_item($resitem);
+        return true;
+    }
+}
\ No newline at end of file
index 27ec08e..81ec9c0 100644 (file)
@@ -37,11 +37,11 @@ class forum1_resurce_file extends general_cc_file {
     protected $attachments = array();
 
     public function set_title($title) {
-        $this->title = $title;
+        $this->title = self::safexml($title);
     }
 
     public function set_text($text, $type='text/plain') {
-        $this->text = $text;
+        $this->text = self::safexml($text);
         $this->text_type = $type;
     }
 
index 1da15a8..af9fd98 100644 (file)
@@ -35,11 +35,11 @@ class page11_resurce_file extends general_cc_file {
     }
 
     public function set_title($value) {
-        $this->title = $value;
+        $this->title = self::safexml($value);
     }
 
     public function set_intro($value) {
-        $this->intro = htmlspecialchars(strip_tags($value), ENT_COMPAT, 'UTF-8', false);
+        $this->intro = self::safexml(strip_tags($value));
     }
 
     protected function on_create() {
index 43b9ac6..eb34779 100644 (file)
@@ -183,20 +183,14 @@ class cc_resource implements cc_i_resource {
             throw new Exception('The file doesnt exist!');
         }
 
-        //TODO: ver el tema de fpatch con el tema de unix y windows
-        //$fpathtocheck = $this->adjust_path($manifestroot,$fname);
-        //!empty($fpathtocheck) &&
-        if (GetDepFiles($manifestroot, $fname, $this->folder, $this->files)) {
-            array_unshift($this->files,$folder.$fname);
-            $this->init_empty_new();
-            $this->href             = $folder.$fname;
-            $this->identifierref    = $folder.$fname;
-            $this->filename         = $fname;
-            $this->isempty          = false;
-            $this->folder           = $folder;
-        } else {
-            $this->init_clean();
-        }
+        GetDepFiles($manifestroot, $fname, $this->folder, $this->files);
+        array_unshift($this->files,$folder.$fname);
+        $this->init_empty_new();
+        $this->href             = $folder.$fname;
+        $this->identifierref    = $folder.$fname;
+        $this->filename         = $fname;
+        $this->isempty          = false;
+        $this->folder           = $folder;
     }
 
     public function adjust_path($mroot, $fname) {
index db68fa2..c117566 100644 (file)
@@ -44,7 +44,7 @@ class url1_resurce_file extends general_cc_file {
      * @param string $title
      */
     public function set_title($title) {
-        $this->title = htmlentities($title);
+        $this->title = self::safexml($title);
     }
 
     /**
index 69be684..c85cbe9 100644 (file)
@@ -41,6 +41,18 @@ class XMLGenericDocument {
     private   $is_html          = false;
 
 
+    /**
+    * @param string $value
+    * @return string
+    */
+    public static function safexml($value) {
+        $result = htmlspecialchars(html_entity_decode($value, ENT_QUOTES, 'UTF-8'),
+                                   ENT_NOQUOTES,
+                                   'UTF-8',
+                                   false);
+        return $result;
+    }
+
     function __construct($ch = 'UTF-8',$validatenow=true){
         $this->charset = $ch;
         $this->documentInit();
index 053d77d..0342462 100644 (file)
@@ -123,12 +123,23 @@ abstract class backup_plan_builder {
 
         // Add the activity task, responsible for outputting
         // all the module related information
-        $plan->add_task(backup_factory::get_backup_activity_task($controller->get_format(), $id));
-
-        // For the given activity, add as many block tasks as necessary
-        $blockids = backup_plan_dbops::get_blockids_from_moduleid($id);
-        foreach ($blockids as $blockid) {
-            $plan->add_task(backup_factory::get_backup_block_task($controller->get_format(), $blockid, $id));
+        try {
+            $plan->add_task(backup_factory::get_backup_activity_task($controller->get_format(), $id));
+
+            // For the given activity, add as many block tasks as necessary
+            $blockids = backup_plan_dbops::get_blockids_from_moduleid($id);
+            foreach ($blockids as $blockid) {
+                try {
+                    $plan->add_task(backup_factory::get_backup_block_task($controller->get_format(), $blockid, $id));
+                } catch (backup_task_exception $e) {
+                    $a = stdClass();
+                    $a->mid = $id;
+                    $a->bid = $blockid;
+                    $controller->log(get_string('error_block_for_module_not_found', 'backup', $a), backup::LOG_WARNING);
+                }
+            }
+        } catch (backup_task_exception $e) {
+            $controller->log(get_string('error_course_module_not_found', 'backup', $id), backup::LOG_WARNING);
         }
     }
 
index 2aebdcf..acf17be 100644 (file)
@@ -1124,6 +1124,12 @@ class restore_course_structure_step extends restore_structure_step {
             unset($data->idnumber);
         }
 
+        // Any empty value for course->hiddensections will lead to 0 (default, show collapsed).
+        // It has been reported that some old 1.9 courses may have it null leading to DB error. MDL-31532
+        if (empty($data->hiddensections)) {
+            $data->hiddensections = 0;
+        }
+
         // Only restrict modules if original course was and target site too for new courses
         $data->restrictmodules = $data->restrictmodules && !empty($CFG->restrictmodulesfor) && $CFG->restrictmodulesfor == 'all';
 
index 74e4bcd..8daffbf 100644 (file)
@@ -110,6 +110,9 @@ if ($usercandownload and $download != -1 and !empty($downloadcourseid) and confi
     $sizeinfo->total = number_format($backupsize / 1000000, 2);
     echo html_writer::tag('div', get_string('downloadingsize', 'block_community', $sizeinfo),
             array('class' => 'textinfo'));
+    if (ob_get_level()) {
+        ob_flush();
+    }
     flush();
     $filenames = $communitymanager->block_community_download_course_backup($course);
     echo html_writer::tag('div', get_string('downloaded', 'block_community'),
index 5128c65..c01445f 100644 (file)
@@ -539,6 +539,7 @@ M.core_dock.fixTitleOrientation = function(item, title, text) {
     svg.appendChild(txt);
 
     title.append(svg);
+    title.append(Y.Node.create('<span class="accesshide">'+text+'</span>'));
 
     item.on('dockeditem:drawcomplete', function(txt, title){
         txt.setAttribute('fill', Y.one(title).getStyle('color'));
index 03c84ca..a851cbe 100644 (file)
@@ -1,8 +1,41 @@
 <?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/>.
+
+/**
+ * Blog RSS Management
+ *
+ * @package    core_blog
+ * @category   rss
+ * @copyright  2010 Andrew Davis
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 require_once($CFG->dirroot.'/lib/rsslib.php');
 require_once($CFG->dirroot .'/blog/lib.php');
 
+/**
+ * Build the URL for the RSS feed
+ *
+ * @param int    $contextid    The context under which the URL should be created
+ * @param int    $userid       The id of the user requesting the RSS Feed
+ * @param string $filtertype   The source of the RSS feed (site/course/group/user)
+ * @param int    $filterselect The id of the item defined by $filtertype
+ * @param int    $tagid        The id of the row in the tag table that identifies the RSS Feed
+ * @return string
+ */
 function blog_rss_get_url($contextid, $userid, $filtertype, $filterselect=0, $tagid=0) {
     $componentname = 'blog';
 
@@ -29,8 +62,15 @@ function blog_rss_get_url($contextid, $userid, $filtertype, $filterselect=0, $ta
     return rss_get_url($contextid, $userid, $componentname, $additionalargs);
 }
 
-// This function returns the icon (from theme) with the link to rss/file.php
-// needs some hacking to rss/file.php
+/**
+ * Print the link for the RSS feed with the correct RSS icon (Theme based)
+ *
+ * @param stdClass    $context      The context under which the URL should be created
+ * @param string      $filtertype   The source of the RSS feed (site/course/group/user)
+ * @param int         $filterselect The id of the item defined by $filtertype
+ * @param int         $tagid        The id of the row in the tag table that identifies the RSS Feed
+ * @param string      $tooltiptext  The tooltip to be displayed with the link
+ */
 function blog_rss_print_link($context, $filtertype, $filterselect=0, $tagid=0, $tooltiptext='') {
     global $CFG, $USER, $OUTPUT;
 
@@ -45,6 +85,15 @@ function blog_rss_print_link($context, $filtertype, $filterselect=0, $tagid=0, $
     print '<div class="mdl-right"><a href="'. $url .'"><img src="'. $rsspix .'" title="'. strip_tags($tooltiptext) .'" alt="'.get_string('rss').'" /></a></div>';
 }
 
+/**
+ * Build the URL for the RSS feed amd add it as a header
+ *
+ * @param stdClass    $context      The context under which the URL should be created
+ * @param string      $title        Name for the link to be added to the page header
+ * @param string      $filtertype   The source of the RSS feed (site/course/group/user)
+ * @param int         $filterselect The id of the item defined by $filtertype
+ * @param int         $tagid        The id of the row in the tag table that identifies the RSS Feed
+ */
 function blog_rss_add_http_header($context, $title, $filtertype, $filterselect=0, $tagid=0) {
     global $PAGE, $USER, $CFG;
 
@@ -63,8 +112,9 @@ function blog_rss_add_http_header($context, $title, $filtertype, $filterselect=0
 
 /**
  * Utility function to extract parameters needed to generate RSS URLs from the blog filters
- * @param <type> $filters
- * @return array array containing the id of the user/course/group, the relevant context and the filter type (site/user/course/group)
+ *
+ * @param  array $filters filters for the blog
+ * @return array array containing the id of the user/course/group, the relevant context and the filter type: site/user/course/group
  */
 function blog_rss_get_params($filters) {
     $thingid = $rsscontext = $filtertype = null;
@@ -99,8 +149,12 @@ function blog_rss_get_params($filters) {
     return array($thingid, $rsscontext, $filtertype);
 }
 
-
-// Generate any blog RSS feed via one function (called by ../rss/file.php)
+/**
+ * Generate any blog RSS feed via one function
+ *
+ * @param stdClass $context The context of the blog for which the feed it being generated
+ * @param array    $args    An array of arguements needed to build the feed (contextid, token, componentname, type, id, tagid)
+ */
 function blog_rss_get_feed($context, $args) {
     global $CFG, $SITE, $DB;
 
@@ -219,7 +273,14 @@ function blog_rss_get_feed($context, $args) {
     }
 }
 
-
+/**
+ * Retrieve the location and file name of a cached RSS feed
+ *
+ * @param string $type  The source of the RSS feed (site/course/group/user)
+ * @param int    $id    The id of the item defined by $type
+ * @param int    $tagid The id of the row in the tag table that identifies the RSS Feed
+ * @return string
+ */
 function blog_rss_file_name($type, $id, $tagid=0) {
     global $CFG;
 
@@ -230,7 +291,15 @@ function blog_rss_file_name($type, $id, $tagid=0) {
     }
 }
 
-//This function saves to file the rss feed specified in the parameters
+/**
+ * This function saves to file the rss feed specified in the parameters
+ *
+ * @param string $type     The source of the RSS feed (site/course/group/user)
+ * @param int    $id       The id of the item defined by $type
+ * @param int    $tagid    The id of the row in the tag table that identifies the RSS Feed
+ * @param string $contents The contents of the RSS Feed file
+ * @return bool whether the save was successful or not
+ */
 function blog_rss_save_file($type, $id, $tagid=0, $contents='') {
     global $CFG;
 
index b8481ad..61ab633 100644 (file)
@@ -100,6 +100,9 @@ echo $OUTPUT->header();
 echo $OUTPUT->heading(get_string('sendingcourse', 'hub'), 3, 'main');
 $renderer = $PAGE->get_renderer('core', 'publish');
 echo $renderer->sendingbackupinfo($backupfile);
+if (ob_get_level()) {
+    ob_flush();
+}
 flush();
 
 //send backup file to the hub
index aa92c84..df3b34f 100644 (file)
@@ -92,7 +92,7 @@ $string['phpldap_noextension'] = '<em>The PHP LDAP module does not seem to be pr
 $string['pluginname'] = 'LDAP enrolments';
 $string['pluginname_desc'] = '<p>You can use an LDAP server to control your enrolments. It is assumed your LDAP tree contains groups that map to the courses, and that each of those groups/courses will have membership entries to map to students.</p><p>It is assumed that courses are defined as groups in LDAP, with each group having multiple membership fields (<em>member</em> or <em>memberUid</em>) that contain a uniqueidentification of the user.</p><p>To use LDAP enrolment, your users <strong>must</strong> to have a valid  idnumber field. The LDAP groups must have that idnumber in the member fields for a user to be enrolled in the course. This will usually work well if you are already using LDAP Authentication.</p><p>Enrolments will be updated when the user logs in. You can also run a script to keep enrolments in synch. Look in <em>enrol/ldap/cli/sync.php</em>.</p><p>This plugin can also be set to automatically create new courses when new groups appear in LDAP.</p>';
 $string['pluginnotenabled'] = 'Plugin not enabled!';
-$string['role_mapping'] = '<p>For each rol that you want to assign from LDAP, you need to specify the list of contexts where the role courses\'s groups are located. Separate different contexts with \';\'.</p><p>You also need to specify the attribute your LDAP server uses to hold the members of a group. Usually \'member\' or \'memberUid\'</p>';
+$string['role_mapping'] = '<p>For each role that you want to assign from LDAP, you need to specify the list of contexts where the role courses\'s groups are located. Separate different contexts with \';\'.</p><p>You also need to specify the attribute your LDAP server uses to hold the members of a group. Usually \'member\' or \'memberUid\'</p>';
 $string['role_mapping_key'] = 'Map roles from LDAP ';
 $string['roles'] = 'Role mapping';
 $string['server_settings'] = 'LDAP server settings';
index b2e8501..9c3a5d6 100644 (file)
@@ -224,8 +224,14 @@ class enrol_manual_plugin extends enrol_plugin {
             'url'                 => $manager->get_moodlepage()->url->out(false),
             'optionsStartDate'    => $startdateoptions,
             'defaultRole'         => $instance->roleid,
-            'disableGradeHistory' => $CFG->disablegradehistory
+            'disableGradeHistory' => $CFG->disablegradehistory,
+            'recoverGradesDefault'=> ''
         );
+
+        if ($CFG->recovergradesdefault) {
+            $arguments['recoverGradesDefault'] = ' checked="checked"';
+        }
+
         $function = 'M.enrol_manual.quickenrolment.init';
         $button->require_yui_module($modules, $function, array($arguments));
         $button->strings_for_js(array(
index 9ed9fbb..d5658b4 100644 (file)
@@ -21,7 +21,8 @@ YUI.add('moodle-enrol_manual-quickenrolment', function(Y) {
         DEFAULTSTARTDATE : 'defaultStartDate',
         DEFAULTDURATION : 'defaultDuration',
         ASSIGNABLEROLES : 'assignableRoles',
-        DISABLEGRADEHISTORY : 'disableGradeHistory'
+        DISABLEGRADEHISTORY : 'disableGradeHistory',
+        RECOVERGRADESDEFAULT : 'recoverGradesDefault'
     };
     /** CSS classes for nodes in structure **/
     var CSS = {
@@ -78,7 +79,7 @@ YUI.add('moodle-enrol_manual-quickenrolment', function(Y) {
             if (this.get(UEP.DISABLEGRADEHISTORY) != true) {
                 recovergrades = create('<div class="'+CSS.ENROLMENTOPTION+' '+CSS.RECOVERGRADES+'"></div>')
                     .append(create('<label class="'+CSS.RECOVERGRADESTITLE+'" for="'+CSS.RECOVERGRADES+'">'+M.str.enrol.recovergrades+'</label>'))
-                    .append(create('<input type="checkbox" id="'+CSS.RECOVERGRADES+'" name="'+CSS.RECOVERGRADES+'" />'))
+                    .append(create('<input type="checkbox" id="'+CSS.RECOVERGRADES+'" name="'+CSS.RECOVERGRADES+'"'+ this.get(UEP.RECOVERGRADESDEFAULT) +' />'))
             }
 
             this.set(UEP.BASE, create('<div class="'+CSS.PANEL+' '+CSS.HIDDEN+'"></div>')
@@ -504,6 +505,9 @@ YUI.add('moodle-enrol_manual-quickenrolment', function(Y) {
             },
             disableGradeHistory : {
                 value : 0
+            },
+            recoverGradesDefault : {
+                value : ''
             }
         }
     });
index 9931484..baa4087 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/>.
 
+/**
+ * A moodleform for editing grade letters
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
 }
index e0a2904..d0dc35a 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,7 +17,7 @@
 /**
  * List of grade letters.
  *
- * @package   moodlecore
+ * @package   core_grades
  * @copyright 2008 Nicolas Connault
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index e87dbb3..a67fa96 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/>.
 
+/**
+ * Prints navigation tabs for viewing and editing grade letters
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
     $row = $tabs = array();
 
     $row[] = new tabobject('lettersview',
index 63462f1..d23b002 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/>.
 
+/**
+ * A page for selecting outcomes for use in a course
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../../config.php';
 require_once $CFG->dirroot.'/grade/lib.php';
 require_once $CFG->libdir.'/gradelib.php';
index 1f4d9b7..d273289 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,7 +17,7 @@
 /**
  * Edit page for grade outcomes.
  *
- * @package   moodlecore
+ * @package   core_grades
  * @copyright 2008 Nicolas Connault
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 6c1893e..fe2c682 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/>.
 
+/**
+ * Edit form for grade outcomes
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
 }
index dbb510f..154db68 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/>.
 
-      // Exports selected outcomes in CSV format.
+/**
+ * Exports selected outcomes in CSV format
+ *
+ * @package   core_grades
+ * @copyright 2008 Moodle Pty Ltd (http://moodle.com)
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 require_once '../../../config.php';
 require_once $CFG->dirroot.'/grade/lib.php';
index 6e62867..b212877 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/>.
 
+/**
+ * Import outcomes from a file
+ *
+ * @package   core_grades
+ * @copyright 2008 Moodle Pty Ltd (http://moodle.com)
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once(dirname(__FILE__).'/../../../config.php');
 require_once($CFG->dirroot.'/lib/formslib.php');
 require_once($CFG->dirroot.'/grade/lib.php');
index f6077c8..4a263c8 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/>.
 
+/**
+ * A form to allow importing outcomes from a file
+ *
+ * @package   core_grades
+ * @copyright 2008 Moodle Pty Ltd (http://moodle.com)
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
 }
index 45915b2..f8df7d8 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,7 +17,7 @@
 /**
  * Listing page for grade outcomes.
  *
- * @package   moodlecore
+ * @package   core_grades
  * @copyright 2008 Nicolas Connault
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 23355bd..50da663 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/>.
 
+/**
+ * Prints navigation tabs for viewing and editing grade outcomes
+ *
+ * @package   core_grades
+ * @copyright 2009 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
     $row = $tabs = array();
 
     $coursecontext = get_context_instance(CONTEXT_COURSE, $courseid);
index f226139..ee633c6 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/>.
 
+/**
+ * Edit page for grade scales
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../../config.php';
 require_once $CFG->dirroot.'/grade/lib.php';
 require_once $CFG->dirroot.'/grade/report/lib.php';
index db75e8e..fa6af48 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/>.
 
+/**
+ * Edit form for grade scales
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
 }
index 237944e..7063feb 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/>.
 
+/**
+ * A page for managing custom and standard scales
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../../config.php';
 require_once $CFG->dirroot.'/grade/lib.php';
 require_once $CFG->libdir.'/gradelib.php';
index 5d541e7..6c9df49 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/>.
 
+/**
+ * A form for editing course grade settings
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
 }
index c4949a4..0ac15f6 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/>.
 
+/**
+ * A page for editing course grade settings
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../../config.php';
 require_once $CFG->dirroot.'/grade/lib.php';
 require_once $CFG->libdir.'/gradelib.php';
index ed8d2af..c350dd4 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/>.
 
+/**
+ * Performs actions on grade items and categories like hiding and locking
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../../config.php';
 require_once $CFG->dirroot.'/grade/lib.php';
 
index 9993324..89d5cd2 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/>.
 
+/**
+ * Edit a calculated grade item
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../../config.php';
 require_once $CFG->dirroot.'/grade/lib.php';
 require_once $CFG->libdir.'/mathslib.php';
index 5ba7af9..fc5e088 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/>.
 
+/**
+ * A moodleform to allow the editing of a calculated grade item
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
 }
index 0c37f8c..100369a 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/>.
 
+/**
+ * Edit the grade options for an individual grade category
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../../config.php';
 require_once $CFG->dirroot.'/grade/lib.php';
 require_once $CFG->dirroot.'/grade/report/lib.php';
index aec1dea..5a1d8f7 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/>.
 
+/**
+ * A moodleform to edit the grade options for an individual grade category
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
 }
index ab188de..53fc1ee 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/>.
 
+/**
+ * Edit a user's grade for a particular activity
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../../config.php';
 require_once $CFG->dirroot.'/grade/lib.php';
 require_once $CFG->dirroot.'/grade/report/lib.php';
index 440146a..a184226 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/>.
 
+/**
+ * A moodleform to allow the editing of a user's grade for a particular activity
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
 }
index 8d88615..801c9ef 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
@@ -16,9 +15,9 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Edit and review page for grade categories and items.
+ * Edit and review page for grade categories and items
  *
- * @package   moodlecore
+ * @package   core_grades
  * @copyright 2008 Nicolas Connault
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 1ce936c..5b2a7c0 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/>.
 
+/**
+ * Edit the grade options for an individual grade item
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
 require_once '../../../config.php';
 require_once $CFG->dirroot.'/grade/lib.php';
 require_once $CFG->dirroot.'/grade/report/lib.php';
index 642be6b..6dd9683 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/>.
 
+/**
+ * A moodleform allowing the editing of the grade options for an individual grade item
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
 }
index 49af487..6057831 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/>.
 
+/**
+ * A library of classes used by the grade edit pages
+ *
+ * @package   core_grades
+ * @copyright 2009 Nicolas Connault
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 class grade_edit_tree {
     public $columns = array();
 
index 518f111..3112d41 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/>.
 
+/**
+ * A page to create or edit outcome grade items
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../../config.php';
 require_once $CFG->dirroot.'/grade/lib.php';
 require_once $CFG->dirroot.'/grade/report/lib.php';
index 4cd5a71..3442599 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/>.
 
+/**
+ * A moodleform to allow the creation and editing of outcome grade items
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
 }
index b88df4e..4d8e705 100644 (file)
@@ -49,6 +49,8 @@
 .gradingform_rubric_editform .status.ready {background-color:#e7f1c3;border-color:#AAEEAA;}
 .gradingform_rubric_editform .status.draft {background-color:#f3f2aa;border-color:#EEEE22;}
 
+.gradingform_rubric {overflow:auto;padding-bottom:1.5em;max-width:720px;position:relative;}
+
 .gradingform_rubric.editor .criterion .controls,
 .gradingform_rubric .criterion .description,
 .gradingform_rubric .criterion .levels,
index 7ccefa9..954f91f 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
@@ -22,7 +21,7 @@
  * area, provides access to the plugin editor and allows user to save the
  * current form as a template or re-use some existing form.
  *
- * @package    core
+ * @package    core_grades
  * @subpackage grading
  * @copyright  2011 David Mudrak <david@moodle.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
index 779e95c..d140cd6 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,7 +17,7 @@
 /**
  * Allows to choose a form from the list of available templates
  *
- * @package    core
+ * @package    core_grades
  * @subpackage grading
  * @copyright  2011 David Mudrak <david@moodle.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
index 4e9f80e..b2d0b65 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/>.
 
-/*
- * Compatibility redirection to reports
+/**
+ * This page is provided for compatability and redirects the user to the default grade report
+ *
+ * @package   core_grades
+ * @copyright 2005 onwards Martin Dougiamas  {@link http://moodle.com}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once '../config.php';
index 25071d2..8c969f2 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,7 +17,7 @@
 /**
  * Functions used by gradebook plugins and reports.
  *
- * @package   moodlecore
+ * @package   core_grades
  * @copyright 2009 Petr Skoda and Nicolas Connault
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -563,7 +562,7 @@ function grade_get_plugin_info($courseid, $active_type, $active_plugin) {
  * A simple class containing info about grade plugins.
  * Can be subclassed for special rules
  *
- * @package moodlecore
+ * @package core_grades
  * @copyright 2009 Nicolas Connault
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -694,7 +693,7 @@ function print_grade_page_head($courseid, $active_type, $active_plugin=null,
 /**
  * Utility class used for return tracking when using edit and other forms in grade plugins
  *
- * @package moodlecore
+ * @package core_grades
  * @copyright 2009 Nicolas Connault
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -1000,7 +999,7 @@ function grade_build_nav($path, $pagename=null, $id=null) {
 /**
  * General structure representing grade items in course
  *
- * @package moodlecore
+ * @package core_grades
  * @copyright 2009 Nicolas Connault
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -1557,7 +1556,7 @@ class grade_structure {
  * Flat structure similar to grade tree.
  *
  * @uses grade_structure
- * @package moodlecore
+ * @package core_grades
  * @copyright 2009 Nicolas Connault
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -1694,7 +1693,7 @@ class grade_seq extends grade_structure {
  * deletion and moving of items and categories within the tree.
  *
  * @uses grade_structure
- * @package moodlecore
+ * @package core_grades
  * @copyright 2009 Nicolas Connault
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index b66756a..6cf9763 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/>.
 
 /**
- * Returns the aggregated or calculated course grade(s) in given course.
- * @public
- * @param int $courseid id of course
- * @param int $userid_or_ids optional id of the graded user or array of ids; if userid not used, returns only information about grade_item
- * @return information about course grade item scaleid, name, grade and locked status, etc. + user grades
+ * Functions used to retrieve grades objects
+ *
+ * @package   core_grades
+ * @category  grade
+ * @copyright 2008 Petr Skoda and Nicolas Connault
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Returns the aggregated or calculated course grade(s) for a single course for one or more users
+ *
+ * @param int $courseid The ID of course
+ * @param int|array $userid_or_ids Optional ID of the graded user or array of user IDs; if userid not used, returns only information about grade_item
+ * @return stdClass Returns an object containing information about course grade item. scaleid, name, grade
+ *         and locked status etc and user course grades: $item->grades[$userid] => $usercoursegrade
  */
 function grade_get_course_grades($courseid, $userid_or_ids=null) {
 
@@ -118,10 +127,10 @@ function grade_get_course_grades($courseid, $userid_or_ids=null) {
 }
 
 /**
- * Returns the aggregated or calculated course grade for the given user(s).
- * @public
- * @param int $userid
- * @param int $courseid optional id of course or array of ids, empty means all uses courses (returns array if not present)
+ * Returns the aggregated or calculated course grade for a single user for one or more courses
+ *
+ * @param int $userid The ID of the single user
+ * @param int|array $courseid_or_ids Optional ID of course or array of IDs, empty means all of the user's courses
  * @return mixed grade info or grades array including item info, false if error
  */
 function grade_get_course_grade($userid, $courseid_or_ids=null) {
@@ -233,8 +242,9 @@ function grade_get_course_grade($userid, $courseid_or_ids=null) {
 /**
  * Returns all grade items (including outcomes) or main item for a given activity identified by $cm object.
  *
- * @param object $cm A course module object (preferably with modname property)
- * @return mixed - array of grade item instances (one if $only_main_item true), false if error or not found
+ * @param cm_info $cm A course module object (preferably with modname property)
+ * @param bool $only_main_item Limit the search to the primary grade item for the activity, 'itemnumber'==0
+ * @return mixed An array of grade item instances, one grade item if $only_main_item == true, false if error or not found
  */
 function grade_get_grade_items_for_activity($cm, $only_main_item=false) {
     global $CFG, $DB;
@@ -261,11 +271,11 @@ function grade_get_grade_items_for_activity($cm, $only_main_item=false) {
 }
 
 /**
- * Returns whether or not user received grades in main grade item for given activity.
+ * Returns whether or not a user received grades in main grade item for given activity
  *
- * @param object $cm
- * @param int $userid
- * @return bool True if graded false if user not graded yet
+ * @param cm_info $cm The activity context module
+ * @param int $userid The user ID
+ * @return bool True if graded, false if user not graded yet
  */
 function grade_is_user_graded_in_activity($cm, $userid) {
 
index 463f1d6..e374510 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/>.
 
+/**
+ * This file receives ajax callbacks for the grader report
+ *
+ * @package   gradereport_grader
+ * @copyright 2008 Nicolas Connault
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 require_once '../../../config.php';
 require_once $CFG->libdir.'/gradelib.php';
index 41715d8..9859577 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/>.
 
+/**
+ * Capability definition for the gradebook grader report
+ *
+ * @package   gradereport_grader
+ * @copyright 2007 Moodle Pty Ltd (http://moodle.com)
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 $capabilities = array(
 
     'gradereport/grader:view' => array(
index 3a35fd8..6cbaff1 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/>.
 
+/**
+ * The gradebook grader report
+ *
+ * @package   gradereport_grader
+ * @copyright 2007 Moodle Pty Ltd (http://moodle.com)
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../../config.php';
 require_once $CFG->libdir.'/gradelib.php';
 require_once $CFG->dirroot.'/grade/lib.php';
index 435f28b..d59dfdd 100644 (file)
@@ -16,7 +16,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Strings for component 'gradereport_grader', language 'en', branch 'MOODLE_20_STABLE'
+ * Strings for component 'gradereport_grader', language 'en'
  *
  * @package   gradereport_grader
  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
index 7c9fb38..5771195 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/>.
 
 /**
- * File in which the grader_report class is defined.
- * @package gradebook
+ * Definition of the grader report class
+ *
+ * @package   gradereport_grader
+ * @copyright 2007 Nicolas Connault
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once($CFG->dirroot . '/grade/report/lib.php');
@@ -26,7 +28,7 @@ require_once($CFG->libdir.'/tablelib.php');
 /**
  * Class providing an API for the grader report building and displaying.
  * @uses grade_report
- * @package gradebook
+ * @package gradereport_grader
  */
 class grade_report_grader extends grade_report {
     /**
index 595eb84..0bac965 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/>.
 
+/**
+ * Grader report preferences configuration page
+ *
+ * @package   gradereport_grader
+ * @copyright 2007 Nicolas Connault
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 set_time_limit(0);
 require_once '../../../config.php';
 require_once $CFG->libdir . '/gradelib.php';
index 93f4c03..ff41d39 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/>.
 
-
 /**
- * Form for grader report preferences.
+ * Form for grader report preferences
  *
- * @package    moodlecore
- * @subpackage grade
+ * @package    gradereport_grader
  * @copyright  2009 Nicolas Connault
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 7a9ce65..ac720c2 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/>.
 
+/**
+ * Allow the editing of grades for a grade item
+ *
+ * @package   gradereport_grader
+ * @copyright 2009 Nicolas Connault
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../../config.php';
 require_once $CFG->libdir.'/gradelib.php';
 require_once $CFG->dirroot.'/grade/lib.php';
index c795b33..7220870 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/>.
 
+/**
+ * Defines site config settings for the grader report
+ *
+ * @package    gradereport_grader
+ * @copyright  2007 Moodle Pty Ltd (http://moodle.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 defined('MOODLE_INTERNAL') || die;
 
 if ($ADMIN->fulltree) {
index c1e4d40..610c594 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/>.
 
+/**
+ * Outputs navigation tabs for the grader report
+ *
+ * @package   gradereport_grader
+ * @copyright 2007 2009 Nicolas Connault
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
     $row = $tabs = array();
     $tabcontext = get_context_instance(CONTEXT_COURSE, $COURSE->id);
     $row[] = new tabobject('graderreport',
index 14c2e50..93ff8e6 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Version details
+ * Version details for the grader report
  *
- * @package    gradereport
- * @subpackage grader
+ * @package    gradereport_grader
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index e4ba906..43aaf66 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/>.
 
+/**
+ * Redirects the user to the default grade report
+ *
+ * @package   core_grades
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../config.php';
 
 $courseid = required_param('id', PARAM_INT);
index a49b89e..2475550 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/>.
 
 /**
- * File containing the grade_report class.
- * @package gradebook
+ * File containing the grade_report class
+ *
+ * @package   core_grades
+ * @copyright 2007 Moodle Pty Ltd (http://moodle.com)
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once($CFG->libdir.'/gradelib.php');
 
 /**
  * An abstract class containing variables and methods used by all or most reports.
- * @abstract
- * @package gradebook
+ * @package core_grades
  */
 abstract class grade_report {
     /**
index d37fa82..a4dcba6 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/>.
 
+/**
+ * Defines capabilities for the outcomes report
+ *
+ * @package   gradereport_outcomes
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 $capabilities = array(
 
     'gradereport/outcomes:view' => array(
index cf73c63..ab49694 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/>.
 
+/**
+ * The gradebook outcomes report
+ *
+ * @package   gradereport_outcomes
+ * @copyright 2007 Nicolas Connault
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 include_once('../../../config.php');
 require_once($CFG->libdir . '/gradelib.php');
 require_once $CFG->dirroot.'/grade/lib.php';
index e82830e..9cc0633 100644 (file)
@@ -16,7 +16,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Strings for component 'gradereport_outcomes', language 'en', branch 'MOODLE_20_STABLE'
+ * Strings for component 'gradereport_outcomes', language 'en'
  *
  * @package   gradereport_outcomes
  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
index d70dc07..9bc1637 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Version details
+ * Version details for the outcomes report
  *
- * @package    gradereport
- * @subpackage outcomes
+ * @package    gradereport_outcomes
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 3e29f06..6843f94 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/>.
 
+/**
+ * Defines capabilities for the overview report
+ *
+ * @package   gradereport_overview
+ * @copyright 2007 Nicolas Connault
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 $capabilities = array(
 
     'gradereport/overview:view' => array(
index fefc771..a1134c7 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/>.
 
+/**
+ * The gradebook overview report
+ *
+ * @package   gradereport_overview
+ * @copyright 2007 Nicolas Connault
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../../config.php';
 require_once $CFG->libdir.'/gradelib.php';
 require_once $CFG->dirroot.'/grade/lib.php';
index 0cf91b9..7829783 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
@@ -16,7 +15,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Strings for component 'gradereport_overview', language 'en', branch 'MOODLE_20_STABLE'
+ * Strings for component 'gradereport_overview', language 'en'
  *
  * @package   gradereport_overview
  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
index b610817..0cd8ff4 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/>.
 
 /**
- * File in which the overview_report class is defined.
- * @package gradebook
+ * Definition of the grade_overview_report class
+ *
+ * @package gradereport_overview
+ * @copyright 2007 Nicolas Connault
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once($CFG->dirroot . '/grade/report/lib.php');
@@ -26,7 +28,7 @@ require_once($CFG->libdir.'/tablelib.php');
 /**
  * Class providing an API for the overview report building and displaying.
  * @uses grade_report
- * @package gradebook
+ * @package gradereport_overview
  */
 class grade_report_overview extends grade_report {
 
index 7de6733..1090d2f 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
@@ -16,9 +15,9 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Renderer for the grade user report
+ * Renderer for the gradebook overview report
  *
- * @package   moodlecore
+ * @package   gradereport_overview
  * @copyright 2010 Sam Hemelryk
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -44,4 +43,4 @@ class gradereport_overview_renderer extends plugin_renderer_base {
         return $output;
     }
 
-}
\ No newline at end of file
+}
index d994637..c1e43d8 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/>.
 
-/// Add settings for this module to the $settings object (it's already defined)
+/**
+ * Defines site settings for the overview gradebook report
+ *
+ * @package gradereport_overview
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 defined('MOODLE_INTERNAL') || die;
 
index 80d7b71..c7761e9 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Version details
+ * Version details for the overview gradebook report
  *
- * @package    gradereport
- * @subpackage overview
+ * @package    gradereport_overview
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index d19d468..ac07dbb 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/>.
 
+/**
+ * Defines capabilities for the user report
+ *
+ * @package   gradereport_user
+ * @copyright 2007 onwards Martin Dougiamas (http://dougiamas.com)
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 $capabilities = array(
 
     'gradereport/user:view' => array(
index 10aeffb..e15c4fb 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/>.
 
+/**
+ * The gradebook user report
+ *
+ * @package   gradereport_user
+ * @copyright 2007 Moodle Pty Ltd (http://moodle.com)
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 require_once '../../../config.php';
 require_once $CFG->libdir.'/gradelib.php';
 require_once $CFG->dirroot.'/grade/lib.php';
index 0ba1725..70da1b1 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
@@ -16,7 +15,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Strings for component 'gradereport_user', language 'en', branch 'MOODLE_20_STABLE'
+ * Strings for component 'gradereport_user', language 'en'
  *
  * @package   gradereport_user
  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
index bc93369..9e823cf 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/>.
 
 /**
- * File in which the user_report class is defined.
- * @package gradebook
+ * Definition of the grade_user_report class is defined
+ *
+ * @package gradereport_user
+ * @copyright 2007 Nicolas Connault
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once($CFG->dirroot . '/grade/report/lib.php');
@@ -31,7 +33,7 @@ define("GRADE_REPORT_USER_SHOW_HIDDEN", 2);
 /**
  * Class providing an API for the user report building and displaying.
  * @uses grade_report
- * @package gradebook
+ * @package gradereport_user
  */
 class grade_report_user extends grade_report {
 
index 1e4b083..c0270f3 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,7 +17,7 @@
 /**
  * Renderer for the grade user report
  *
- * @package   moodlecore
+ * @package   gradereport_user
  * @copyright 2010 Sam Hemelryk
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -44,4 +43,4 @@ class gradereport_user_renderer extends plugin_renderer_base {
         return $output;
     }
 
-}
\ No newline at end of file
+}
index 5d53534..d469f68 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/>.
 
-/// Add settings for this module to the $settings object (it's already defined)
+/**
+ * Defines site settings for the user gradebook report
+ *
+ * @package gradereport_user
+ * @copyright 2007 Petr Skoda
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 defined('MOODLE_INTERNAL') || die;
 
index 6532800..2250edb 100644 (file)
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Version details
+ * Version details for the user gradebook report
  *
- * @package    gradereport
- * @subpackage user
+ * @package    gradereport_user
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index 8e91578..3b26a2c 100644 (file)
@@ -19,8 +19,8 @@
  * Add/remove group from grouping.
  *
  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @package groups
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package   core_group
  */
 
 require_once('../config.php');
index 42fc1dc..35d36d0 100644 (file)
@@ -1,11 +1,26 @@
 <?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/>.
+
+
 /**
- * Create and allocate users go groups
+ * Create and allocate users to groups
  *
- * @author  Matt Clarkson mattc@catalyst.net.nz
- * @version 0.0.1
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package groups
+ * @package    core_group
+ * @copyright  Matt Clarkson mattc@catalyst.net.nz
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once('../config.php');
@@ -239,4 +254,4 @@ if($preview !== '') {
     echo $preview;
 }
 
-echo $OUTPUT->footer();
+echo $OUTPUT->footer();
\ No newline at end of file
index 36433f0..5b39965 100644 (file)
@@ -1,5 +1,27 @@
 <?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/>.
+
+
+/**
+ * Auto group form
+ *
+ * @package    core_group
+ * @copyright  2007 mattc-catalyst (http://moodle.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
 }
@@ -7,10 +29,18 @@ if (!defined('MOODLE_INTERNAL')) {
 require_once($CFG->dirroot.'/lib/formslib.php');
 require_once($CFG->dirroot.'/cohort/lib.php');
 
-/// get url variables
+/**
+ * Auto group form class
+ *
+ * @package    core_group
+ * @copyright  2007 mattc-catalyst (http://moodle.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 class autogroup_form extends moodleform {
 
-    // Define the form
+    /**
+     * Form Definition
+     */
     function definition() {
         global $CFG, $COURSE;
 
@@ -110,7 +140,13 @@ class autogroup_form extends moodleform {
         $mform->closeHeaderBefore('buttonar');
     }
 
-
+    /**
+     * Performs validation of the form information
+     *
+     * @param array $data
+     * @param array $files
+     * @return array $errors An array of $errors
+     */
     function validation($data, $files) {
         global $CFG, $COURSE;
         $errors = parent::validation($data, $files);
index 9b0c41f..f818348 100644 (file)
@@ -1,8 +1,23 @@
+// 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/>.
+
 /**
  * Client-side JavaScript for group management interface.
- * @author vy-shane AT moodle.com
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package groups
+ * @copyright vy-shane AT moodle.com
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package core_group
  */
 
 
index 3d5af15..a1750df 100644 (file)
@@ -1,11 +1,26 @@
 <?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/>.
+
+
 /**
  * Delete group
  *
- * @copyright &copy; 2008 The Open University
- * @author s.marshall AT open.ac.uk
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package groups
+ * @package   core_group
+ * @copyright 2008 The Open University, s.marshall AT open.ac.uk
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once('../config.php');
index 7ff57d5..ceadcb7 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 @@
 /**
  * External groups API
  *
- * @package    moodlecore
- * @subpackage webservice
+ * @package    core_group
  * @copyright  2009 Moodle Pty Ltd (http://moodle.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -28,6 +26,10 @@ require_once("$CFG->libdir/externallib.php");
 
 /**
  * Group functions
+ *
+ * @package    core_group
+ * @copyright  2009 Moodle Pty Ltd (http://moodle.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class core_group_external extends external_api {
 
@@ -100,9 +102,9 @@ class core_group_external extends external_api {
         return $groups;
     }
 
-   /**
+    /**
      * Returns description of method result value
-     * @return external_description
+     * @return external_multiple_structure
      */
     public static function create_groups_returns() {
         return new external_multiple_structure(
@@ -163,9 +165,9 @@ class core_group_external extends external_api {
         return $groups;
     }
 
-   /**
+    /**
      * Returns description of method result value
-     * @return external_description
+     * @return external_multiple_structure
      */
     public static function get_groups_returns() {
         return new external_multiple_structure(
@@ -224,9 +226,9 @@ class core_group_external extends external_api {
         return $groups;
     }
 
-   /**
+    /**
      * Returns description of method result value
-     * @return external_description
+     * @return external_multiple_structure
      */
     public static function get_course_groups_returns() {
         return new external_multiple_structure(
@@ -294,7 +296,7 @@ class core_group_external extends external_api {
         $transaction->allow_commit();
     }
 
-   /**
+    /**
      * Returns description of method result value
      * @return external_description
      */
@@ -349,7 +351,7 @@ class core_group_external extends external_api {
         return $members;
     }
 
-   /**
+    /**
      * Returns description of method result value
      * @return external_description
      */
@@ -387,7 +389,6 @@ class core_group_external extends external_api {
     /**
      * Add group members
      * @param array $members of arrays with keys userid, groupid
-     * @return void
      */
     public static function add_group_members($members) {
         global $CFG, $DB;
@@ -429,7 +430,7 @@ class core_group_external extends external_api {
         $transaction->allow_commit();
     }
 
-   /**
+    /**
      * Returns description of method result value
      * @return null
      */
@@ -460,7 +461,6 @@ class core_group_external extends external_api {
     /**
      * Delete group members
      * @param array $members of arrays with keys userid, groupid
-     * @return void
      */
     public static function delete_group_members($members) {
         global $CFG, $DB;
@@ -497,7 +497,7 @@ class core_group_external extends external_api {
         $transaction->allow_commit();
     }
 
-   /**
+    /**
      * Returns description of method result value
      * @return null
      */
@@ -509,13 +509,15 @@ class core_group_external extends external_api {
 
 /**
  * Deprecated group functions
- * @deprecated since Moodle 2.2 please use core_group_external instead
+ * @deprecated since Moodle 2.2 please do not call this class any more.
+ * @see core_group_external()
  */
 class moodle_group_external extends external_api {
 
     /**
      * Returns description of method parameters
-     * @deprecated since Moodle 2.2 please use core_group_external::create_groups_parameters instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::create_groups_parameters()
      * @return external_function_parameters
      */
     public static function create_groups_parameters() {
@@ -524,7 +526,8 @@ class moodle_group_external extends external_api {
 
     /**
      * Create groups
-     * @deprecated since Moodle 2.2 please use core_group_external::create_groups instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::create_groups()
      * @param array $groups array of group description arrays (with keys groupname and courseid)
      * @return array of newly created groups
      */
@@ -532,9 +535,10 @@ class moodle_group_external extends external_api {
         return core_group_external::create_groups($groups);
     }
 
-   /**
+    /**
      * Returns description of method result value
-     * @deprecated since Moodle 2.2 please use core_group_external::create_groups_returns instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::create_groups_returns()
      * @return external_description
      */
     public static function create_groups_returns() {
@@ -543,7 +547,8 @@ class moodle_group_external extends external_api {
 
     /**
      * Returns description of method parameters
-     * @deprecated since Moodle 2.2 please use core_group_external::get_groups_parameters instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::get_groups_parameters()
      * @return external_function_parameters
      */
     public static function get_groups_parameters() {
@@ -552,7 +557,8 @@ class moodle_group_external extends external_api {
 
     /**
      * Get groups definition specified by ids
-     * @deprecated since Moodle 2.2 please use core_group_external::get_groups instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::get_groups()
      * @param array $groupids arrays of group ids
      * @return array of group objects (id, courseid, name, enrolmentkey)
      */
@@ -560,9 +566,10 @@ class moodle_group_external extends external_api {
         return core_group_external::get_groups($groupids);
     }
 
-   /**
+    /**
      * Returns description of method result value
-     * @deprecated since Moodle 2.2 please use core_group_external::get_groups_returns instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::get_groups_returns()
      * @return external_description
      */
     public static function get_groups_returns() {
@@ -571,7 +578,8 @@ class moodle_group_external extends external_api {
 
     /**
      * Returns description of method parameters
-     * @deprecated since Moodle 2.2 please use core_group_external::get_course_groups_parameters instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::get_course_groups_parameters()
      * @return external_function_parameters
      */
     public static function get_course_groups_parameters() {
@@ -580,7 +588,8 @@ class moodle_group_external extends external_api {
 
     /**
      * Get all groups in the specified course
-     * @deprecated since Moodle 2.2 please use core_group_external::get_course_groups instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::get_course_groups()
      * @param int $courseid id of course
      * @return array of group objects (id, courseid, name, enrolmentkey)
      */
@@ -588,9 +597,10 @@ class moodle_group_external extends external_api {
         return core_group_external::get_course_groups($courseid);
     }
 
-   /**
+    /**
      * Returns description of method result value
-     * @deprecated since Moodle 2.2 please use core_group_external::get_course_groups_returns instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::get_course_groups_returns()
      * @return external_description
      */
     public static function get_course_groups_returns() {
@@ -599,7 +609,8 @@ class moodle_group_external extends external_api {
 
     /**
      * Returns description of method parameters
-     * @deprecated since Moodle 2.2 please use core_group_external::delete_group_members_parameters instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::delete_group_members_parameters()
      * @return external_function_parameters
      */
     public static function delete_groups_parameters() {
@@ -608,7 +619,8 @@ class moodle_group_external extends external_api {
 
     /**
      * Delete groups
-     * @deprecated since Moodle 2.2 please use core_group_external::delete_groups instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::delete_groups()
      * @param array $groupids array of group ids
      * @return void
      */
@@ -616,9 +628,10 @@ class moodle_group_external extends external_api {
         return core_group_external::delete_groups($groupids);
     }
 
-   /**
+    /**
      * Returns description of method result value
-    * @deprecated since Moodle 2.2 please use core_group_external::delete_group_members_returns instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::delete_group_members_returns()
      * @return external_description
      */
     public static function delete_groups_returns() {
@@ -628,7 +641,8 @@ class moodle_group_external extends external_api {
 
     /**
      * Returns description of method parameters
-     * @deprecated since Moodle 2.2 please use core_group_external::get_group_members_parameters instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::get_group_members_parameters()
      * @return external_function_parameters
      */
     public static function get_groupmembers_parameters() {
@@ -637,7 +651,8 @@ class moodle_group_external extends external_api {
 
     /**
      * Return all members for a group
-     * @deprecated since Moodle 2.2 please use core_group_external::get_group_members instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::get_group_members()
      * @param array $groupids array of group ids
      * @return array with  group id keys containing arrays of user ids
      */
@@ -645,9 +660,10 @@ class moodle_group_external extends external_api {
         return core_group_external::get_group_members($groupids);
     }
 
-   /**
+    /**
      * Returns description of method result value
-     * @deprecated since Moodle 2.2 please use core_group_external::get_group_members_returns instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::get_group_members_returns()
      * @return external_description
      */
     public static function get_groupmembers_returns() {
@@ -657,7 +673,8 @@ class moodle_group_external extends external_api {
 
     /**
      * Returns description of method parameters
-     * @deprecated since Moodle 2.2 please use core_group_external::add_group_members_parameters instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::add_group_members_parameters()
      * @return external_function_parameters
      */
     public static function add_groupmembers_parameters() {
@@ -666,7 +683,8 @@ class moodle_group_external extends external_api {
 
     /**
      * Add group members
-     * @deprecated since Moodle 2.2 please use core_group_external::add_group_members instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::add_group_members()
      * @param array $members of arrays with keys userid, groupid
      * @return void
      */
@@ -674,9 +692,10 @@ class moodle_group_external extends external_api {
         return core_group_external::add_group_members($members);
     }
 
-   /**
+    /**
      * Returns description of method result value
-     * @deprecated since Moodle 2.2 please use core_group_external::add_group_members_returns instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::add_group_members_returns()
      * @return external_description
      */
     public static function add_groupmembers_returns() {
@@ -686,7 +705,8 @@ class moodle_group_external extends external_api {
 
     /**
      * Returns description of method parameters
-     * @deprecated since Moodle 2.2 please use core_group_external::delete_group_members_parameters instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::delete_group_members_parameters()
      * @return external_function_parameters
      */
     public static function delete_groupmembers_parameters() {
@@ -695,7 +715,8 @@ class moodle_group_external extends external_api {
 
     /**
      * Delete group members
-     * @deprecated since Moodle 2.2 please use core_group_external::delete_group_members instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::delete_group_members()
      * @param array $members of arrays with keys userid, groupid
      * @return void
      */
@@ -703,13 +724,14 @@ class moodle_group_external extends external_api {
         return core_group_external::delete_group_members($members);
     }
 
-   /**
+    /**
      * Returns description of method result value
-     * @deprecated since Moodle 2.2 please use core_group_external::delete_group_members_returns instead
+     * @deprecated since Moodle 2.2 please do not call this function any more.
+     * @see core_group_external::delete_group_members_returns()
      * @return external_description
      */
     public static function delete_groupmembers_returns() {
         return core_group_external::delete_group_members_returns();
     }
 
-}
\ No newline at end of file
+}
index e35c228..cf12016 100644 (file)
@@ -1,12 +1,26 @@
 <?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/>.
+
+
 /**
  * Create group OR edit group settings.
  *
- * @copyright &copy; 2006 The Open University
- * @author N.D.Freear AT open.ac.uk
- * @author J.White AT open.ac.uk
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package groups
+ * @copyright 2006 The Open University, N.D.Freear AT open.ac.uk, J.White AT open.ac.uk
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package   core_group
  */
 
 require_once('../config.php');
index 65de0c8..1563949 100644 (file)
@@ -1,23 +1,44 @@
 <?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/>.
+
 
 /**
- * Create//edit group form.
+ * A form for the creation and editing of groups.
  *
- * @copyright &copy; 2006 The Open University
- * @author N.D.Freear AT open.ac.uk
- * @author J.White AT open.ac.uk
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package groups
+ * @copyright 2006 The Open University, N.D.Freear AT open.ac.uk, J.White AT open.ac.uk
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package   core_group
  */
 
 defined('MOODLE_INTERNAL') || die;
 
 require_once($CFG->dirroot.'/lib/formslib.php');
 
-/// get url variables
+/**
+ * Group form class
+ *
+ * @copyright 2006 The Open University, N.D.Freear AT open.ac.uk, J.White AT open.ac.uk
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package   core_group
+ */
 class group_form extends moodleform {
 
-    // Define the form
+    /**
+     * Definition of the form
+     */
     function definition () {
         global $USER, $CFG, $COURSE;
 
@@ -52,6 +73,13 @@ class group_form extends moodleform {
         $this->add_action_buttons();
     }
 
+    /**
+     * Form validation
+     *
+     * @param array $data
+     * @param array $files
+     * @return array $errors An array of errors
+     */
     function validation($data, $files) {
         global $COURSE, $DB, $CFG;
 
@@ -82,6 +110,11 @@ class group_form extends moodleform {
         return $errors;
     }
 
+    /**
+     * Get editor options for this form
+     *
+     * @return array An array of options
+     */
     function get_editor_options() {
         return $this->_customdata['editoroptions'];
     }
index 7d80e65..8ac9eb6 100644 (file)
@@ -1,12 +1,26 @@
 <?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/>.
+
+
 /**
  * Create grouping OR edit grouping settings.
  *
- * @copyright &copy; 2006 The Open University
- * @author N.D.Freear AT open.ac.uk
- * @author J.White AT open.ac.uk
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package groups
+ * @copyright 2006 The Open University, N.D.Freear AT open.ac.uk, J.White AT open.ac.uk
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package   core_group
  */
 require_once('../config.php');
 require_once('lib.php');
index 5842602..f438882 100644 (file)
@@ -1,12 +1,26 @@
 <?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/>.
+
+
 /**
- * Create/Edit grouping form.
+ * A form for creating and editing groupings.
  *
- * @copyright &copy; 2006 The Open University
- * @author N.D.Freear AT open.ac.uk
- * @author J.White AT open.ac.uk
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package groups
+ * @copyright 2006 The Open University, N.D.Freear AT open.ac.uk, J.White AT open.ac.uk
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package   core_group
  */
 
 if (!defined('MOODLE_INTERNAL')) {
@@ -15,10 +29,18 @@ if (!defined('MOODLE_INTERNAL')) {
 
 require_once($CFG->dirroot.'/lib/formslib.php');
 
-/// get url variables
+/**
+ * Grouping form class
+ *
+ * @copyright 2006 The Open University, N.D.Freear AT open.ac.uk, J.White AT open.ac.uk
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package   core_group
+ */
 class grouping_form extends moodleform {
 
-    // Define the form
+    /**
+     * Form definition
+     */
     function definition () {
         global $USER, $CFG, $COURSE;
 
@@ -41,6 +63,13 @@ class grouping_form extends moodleform {
         $this->add_action_buttons();
     }
 
+    /**
+     * Form validation
+     *
+     * @param array $data
+     * @param array $files
+     * @return array $errors An array of validataion errors for the form.
+     */
     function validation($data, $files) {
         global $COURSE, $DB;
 
index 80ad8bd..b43f9b9 100644 (file)
@@ -20,7 +20,7 @@
  *
  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @package groups
+ * @package core_group
  */
 
 require_once '../config.php';
index 159cd43..ae85c96 100644 (file)
@@ -20,7 +20,7 @@
  *
  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @package course
+ * @package core_group
  */
 
 require_once('../config.php');
index 99e3206..6021c44 100644 (file)
@@ -1,4 +1,26 @@
 <?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/>.
+
+/**
+ * A form for group import.
+ *
+ * @package    core_group
+ * @copyright  2010 Toyomoyo (http://moodle.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
@@ -6,8 +28,18 @@ if (!defined('MOODLE_INTERNAL')) {
 
 require_once($CFG->libdir.'/formslib.php');
 
+/**
+ * Groups import form class
+ *
+ * @package    core_group
+ * @copyright  2010 Toyomoyo (http://moodle.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 class groups_import_form extends moodleform {
 
+    /**
+     * Form definition
+     */
     function definition() {
         $mform =& $this->_form;
         $data  = $this->_customdata;
index 4b75d8e..c005e6f 100644 (file)
@@ -1,12 +1,26 @@
 <?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/>.
+
+
 /**
  * The main group management user interface.
  *
- * @copyright &copy; 2006 The Open University
- * @author N.D.Freear AT open.ac.uk
- * @author J.White AT open.ac.uk
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package groups
+ * @copyright 2006 The Open University, N.D.Freear AT open.ac.uk, J.White AT open.ac.uk
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package   core_group
  */
 require_once('../config.php');
 require_once('lib.php');
@@ -269,8 +283,8 @@ echo $OUTPUT->footer();
 /**
  * Returns the first button action with the given prefix, taken from
  * POST or GET, otherwise returns false.
- * See /lib/moodlelib.php function optional_param.
- * @param $prefix 'act_' as in 'action'.
+ * @see /lib/moodlelib.php function optional_param().
+ * @param string $prefix 'act_' as in 'action'.
  * @return string The action without the prefix, or false if no action found.
  */
 function groups_param_action($prefix = 'act_') {
index aef61d7..c933fbf 100644 (file)
@@ -1,11 +1,26 @@
 <?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/>.
+
+
 /**
  * Extra library for groups and groupings.
  *
- * @copyright &copy; 2006 The Open University
- * @author J.White AT open.ac.uk, Petr Skoda (skodak)
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package groups
+ * @copyright 2006 The Open University, J.White AT open.ac.uk, Petr Skoda (skodak)
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package   core_group
  */
 
 /*
 
 /**
  * Adds a specified user to a group
- * @param mixed $groupid  The group id or group object
- * @param mixed $userid   The user id or user object
- * @return boolean True if user added successfully or the user is already a
+ *
+ * @param mixed $grouporid  The group id or group object
+ * @param mixed $userorid   The user id or user object
+ * @return bool True if user added successfully or the user is already a
  * member of the group, false otherwise.
  */
 function groups_add_member($grouporid, $userorid) {
@@ -69,9 +85,10 @@ function groups_add_member($grouporid, $userorid) {
 
 /**
  * Deletes the link between the specified user and group.
- * @param mixed $groupid  The group id or group object
- * @param mixed $userid   The user id or user object
- * @return boolean True if deletion was successful, false otherwise
+ *
+ * @param mixed $grouporid  The group id or group object
+ * @param mixed $userorid   The user id or user object
+ * @return bool True if deletion was successful, false otherwise
  */
 function groups_remove_member($grouporid, $userorid) {
     global $DB;
@@ -112,8 +129,10 @@ function groups_remove_member($grouporid, $userorid) {
 
 /**
  * Add a new group
- * @param object $data group properties
- * @param object $um upload manager with group picture
+ *
+ * @param stdClass $data group properties
+ * @param stdClass $editform
+ * @param array $editoroptions
  * @return id of group or false if error
  */
 function groups_create_group($data, $editform = false, $editoroptions = false) {
@@ -158,7 +177,9 @@ function groups_create_group($data, $editform = false, $editoroptions = false) {
 
 /**
  * Add a new grouping
- * @param object $data grouping properties
+ *
+ * @param stdClass $data grouping properties
+ * @param array $editoroptions
  * @return id of grouping or false if error
  */
 function groups_create_grouping($data, $editoroptions=null) {
@@ -193,9 +214,10 @@ function groups_create_grouping($data, $editoroptions=null) {
 
 /**
  * Update the group icon from form data
- * @param $group
- * @param $data
- * @param $editform
+ *
+ * @param stdClass $group group information
+ * @param stdClass $data
+ * @param stdClass $editform
  */
 function groups_update_group_icon($group, $data, $editform) {
     global $CFG, $DB;
@@ -221,10 +243,11 @@ function groups_update_group_icon($group, $data, $editform) {
 
 /**
  * Update group
- * @param object $data group properties (with magic quotes)
- * @param object $editform
+ *
+ * @param stdClass $data group properties (with magic quotes)
+ * @param stdClass $editform
  * @param array $editoroptions
- * @return boolean true or exception
+ * @return bool true or exception
  */
 function groups_update_group($data, $editform = false, $editoroptions = false) {
     global $CFG, $DB;
@@ -255,8 +278,10 @@ function groups_update_group($data, $editform = false, $editoroptions = false) {
 
 /**
  * Update grouping
- * @param object $data grouping properties (with magic quotes)
- * @return boolean true or exception
+ *
+ * @param stdClass $data grouping properties (with magic quotes)
+ * @param array $editoroptions
+ * @return bool true or exception
  */
 function groups_update_grouping($data, $editoroptions=null) {
     global $DB;
@@ -275,8 +300,9 @@ function groups_update_grouping($data, $editoroptions=null) {
 /**
  * Delete a group best effort, first removing members and links with courses and groupings.
  * Removes group avatar too.
+ *
  * @param mixed $grouporid The id of group to delete or full group object
- * @return boolean True if deletion was successful, false otherwise
+ * @return bool True if deletion was successful, false otherwise
  */
 function groups_delete_group($grouporid) {
     global $CFG, $DB;
@@ -316,6 +342,7 @@ function groups_delete_group($grouporid) {
 
 /**
  * Delete grouping
+ *
  * @param int $groupingorid
  * @return bool success
  */
@@ -357,6 +384,7 @@ function groups_delete_grouping($groupingorid) {
 
 /**
  * Remove all users (or one user) from all groups in course
+ *
  * @param int $courseid
  * @param int $userid 0 means all users
  * @param bool $showfeedback
@@ -397,6 +425,7 @@ function groups_delete_group_members($courseid, $userid=0, $showfeedback=false)
 
 /**
  * Remove all groups from all groupings in course
+ *
  * @param int $courseid
  * @param bool $showfeedback
  * @return bool success
@@ -417,6 +446,7 @@ function groups_delete_groupings_groups($courseid, $showfeedback=false) {
 
 /**
  * Delete all groups from course
+ *
  * @param int $courseid
  * @param bool $showfeedback
  * @return bool success
@@ -456,6 +486,7 @@ function groups_delete_groups($courseid, $showfeedback=false) {
 
 /**
  * Delete all groupings from course
+ *
  * @param int $courseid
  * @param bool $showfeedback
  * @return bool success
@@ -497,7 +528,8 @@ function groups_delete_groupings($courseid, $showfeedback=false) {
 /**
  * Obtains a list of the possible roles that group members might come from,
  * on a course. Generally this includes only profile roles.
- * @param object $context Context of course
+ *
+ * @param context $context Context of course
  * @return Array of role ID integers, or false if error/none.
  */
 function groups_get_possible_roles($context) {
@@ -508,6 +540,7 @@ function groups_get_possible_roles($context) {
 
 /**
  * Gets potential group members for grouping
+ *
  * @param int $courseid The id of the course
  * @param int $roleid The role to select users from
  * @param int $cohortid restrict to cohort id
@@ -553,6 +586,7 @@ function groups_get_potential_members($courseid, $roleid = null, $cohortid = nul
 
 /**
  * Parse a group name for characters to replace
+ *
  * @param string $format The format a group name will follow
  * @param int $groupnumber The number of the group to be used in the parsed format string
  * @return string the parsed format string
@@ -572,6 +606,7 @@ function groups_parse_name($format, $groupnumber) {
 
 /**
  * Assigns group into grouping
+ *
  * @param int groupingid
  * @param int groupid
  * @return bool true or exception
@@ -593,6 +628,7 @@ function groups_assign_grouping($groupingid, $groupid) {
 
 /**
  * Unassigns group grom grouping
+ *
  * @param int groupingid
  * @param int groupid
  * @return bool success
@@ -614,6 +650,7 @@ function groups_unassign_grouping($groupingid, $groupid) {
  * and pseudo-role details (including a name, 'No role'). Users with multiple
  * roles, same deal with key '*' and name 'Multiple roles'. You can find out
  * which roles each has by looking in the $roles array of the user object.
+ *
  * @param int $groupid
  * @param int $courseid Course ID (should match the group's course)
  * @param string $fields List of fields from user table prefixed with u, default 'u.*'
@@ -654,8 +691,8 @@ function groups_get_members_by_role($groupid, $courseid, $fields='u.*',
  * results of a database query that includes a list of users and possible
  * roles on a course.
  *
- * @param object $rs The record set (may be false)
- * @param int $contextid ID of course context
+ * @param moodle_recordset $rs The record set (may be false)
+ * @param int $context ID of course context
  * @return array As described in groups_get_members_by_role
  */
 function groups_calculate_role_people($rs, $context) {
index fd53b13..d302bf7 100644 (file)
@@ -1,12 +1,26 @@
 <?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/>.
+
+
 /**
  * Add/remove members from group.
  *
- * @copyright &copy; 2006 The Open University and others
- * @author N.D.Freear AT open.ac.uk
- * @author J.White AT open.ac.uk and others
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package groups
+ * @copyright 2006 The Open University and others, N.D.Freear AT open.ac.uk, J.White AT open.ac.uk and others
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package   core_group
  */
 require_once(dirname(__FILE__) . '/../config.php');
 require_once(dirname(__FILE__) . '/lib.php');
index 75efcc7..d9f94e1 100644 (file)
@@ -1,11 +1,26 @@
 <?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/>.
+
+
 /**
  * Print an overview of groupings & group membership
  *
- * @author  Matt Clarkson mattc@catalyst.net.nz
- * @version 0.0.1
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package groups
+ * @copyright  Matt Clarkson mattc@catalyst.net.nz
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    core_group
  */
 
 require_once('../config.php');
index c70f3c2..322d05d 100644 (file)
@@ -1,4 +1,26 @@
 <?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/>.
+
+/**
+ * Prints navigation tabs
+ *
+ * @package    core_group
+ * @copyright  2010 Petr Skoda (http://moodle.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
     $row = $tabs = array();
     $row[] = new tabobject('groups',
                            $CFG->wwwroot.'/group/index.php?id='.$courseid,
index 19bf2ce..77188d0 100644 (file)
@@ -40,7 +40,7 @@ $string['cannotsavezipfile'] = 'No s\'ha pogut desar el fitxer zip';
 $string['cannotunzipfile'] = 'No s\'ha pogut descomprimir el fitxer';
 $string['componentisuptodate'] = 'El component està al dia';
 $string['downloadedfilecheckfailed'] = 'Ha fallat la comprovació del fitxer baixat.';
-$string['invalidmd5'] = 'El md5 no és vàlid';
+$string['invalidmd5'] = 'L\'md5 no és vàlid. Torneu-ho a provar';
 $string['missingrequiredfield'] = 'Falta algun camp necessari';
 $string['remotedownloaderror'] = 'No s\'ha pogut baixar el component al vostre servidor. Verifiqueu els paràmetres de servidor intermediari. Es recomana l\'extensió cURL.<br /><br />Haureu de baixar manualment el fitxer <a href="{$a->url}">{$a->url}</a>, copiar-lo a la ubicació "{$a->dest}" del vostre servidor i descomprimir-lo allí.';
 $string['wrongdestpath'] = 'El camí de destinació és erroni';
index 91b80c0..ceff3da 100644 (file)
 defined('MOODLE_INTERNAL') || die();
 
 $string['clianswerno'] = 'n';
-$string['cliansweryes'] = 'j';
+$string['cliansweryes'] = 'y';
 $string['cliincorrectvalueerror'] = 'Fehler: Falscher Wert "{$a->value}" für "{$a->option}"';
-$string['cliincorrectvalueretry'] = 'Falscher Wert - versuchen Sie es nochmal';
+$string['cliincorrectvalueretry'] = 'Falscher Wert - bitte nochmal';
 $string['clitypevalue'] = 'Wert eingeben';
-$string['clitypevaluedefault'] = 'Wert eingeben. Drücken Sie Enter, um den Standardwert zu benutzen ({$a})';
+$string['clitypevaluedefault'] = 'Wert eingeben oder Standardwert benutzen ({$a})';
 $string['cliunknowoption'] = 'Nicht erkannte Optionen: 
   {$a}
-Für Hilfe nutzen Sie bitte die Hilfefunktion.';
-$string['cliyesnoprompt'] = 'tippen Sie y (für yes=ja) oder n (für no=nein)';
+Hilfe wird über die Option -help angezeigt.';
+$string['cliyesnoprompt'] = 'y (yes=ja) oder n (no=nein) eingeben';
 $string['environmentrequireinstall'] = 'muss installiert und aktiviert sein';
 $string['environmentrequireversion'] = 'Version {$a->needed} ist erforderlich - aktuell ist {$a->current} installiert.';
index ab9874e..62c0f17 100644 (file)
@@ -40,5 +40,5 @@ $string['cliunknowoption'] = 'Opzioni non riconosciute:
 {$a}
 . Per favore utilizza l\'opzione --help.';
 $string['cliyesnoprompt'] = 'inserisci s (per Si) o n (per No)';
-$string['environmentrequireinstall'] = 'l\'installazione e attivazione è necessaria';
+$string['environmentrequireinstall'] = 'E\' necessaria l\'installazione e attivazione';
 $string['environmentrequireversion'] = 'Versione minima necessaria: {$a->needed}. Versione in uso: {$a->current}';
diff --git a/install/lang/ka/moodle.php b/install/lang/ka/moodle.php
new file mode 100644 (file)
index 0000000..8445a31
--- /dev/null
@@ -0,0 +1,33 @@
+<?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/>.
+
+/**
+ * Automatically generated strings for Moodle 2.3dev installer
+ *
+ * Do not edit this file manually! It contains just a subset of strings
+ * needed during the very first steps of installation. This file was
+ * generated automatically by export-installer.php (which is part of AMOS
+ * {@link http://docs.moodle.org/dev/Languages/AMOS}) using the
+ * list of strings defined in /install/stringnames.txt.
+ *
+ * @package   installer
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$string['language'] = 'ენა';
diff --git a/install/lang/lt/admin.php b/install/lang/lt/admin.php
new file mode 100644 (file)
index 0000000..61ecc37
--- /dev/null
@@ -0,0 +1,34 @@
+<?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/>.
+
+/**
+ * Automatically generated strings for Moodle 2.3dev installer
+ *
+ * Do not edit this file manually! It contains just a subset of strings
+ * needed during the very first steps of installation. This file was
+ * generated automatically by export-installer.php (which is part of AMOS
+ * {@link http://docs.moodle.org/dev/Languages/AMOS}) using the
+ * list of strings defined in /install/stringnames.txt.
+ *
+ * @package   installer
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$string['environmentrequireinstall'] = 'turi būti įdiegta ir įgalinta';
+$string['environmentrequireversion'] = 'reikalinga $a-needed, o Jūs turite $a-current';
index 9a015b4..2deaa38 100644 (file)
@@ -33,3 +33,4 @@ defined('MOODLE_INTERNAL') || die();
 $string['language'] = 'Kalba';
 $string['next'] = 'Toliau';
 $string['previous'] = 'Ankstesnis';
+$string['reload'] = 'Įkelti iš naujo';
diff --git a/install/lang/lt_uni/langconfig.php b/install/lang/lt_uni/langconfig.php
new file mode 100644 (file)
index 0000000..17ae4da
--- /dev/null
@@ -0,0 +1,34 @@
+<?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/>.
+
+/**
+ * Automatically generated strings for Moodle 2.3dev installer
+ *
+ * Do not edit this file manually! It contains just a subset of strings
+ * needed during the very first steps of installation. This file was
+ * generated automatically by export-installer.php (which is part of AMOS
+ * {@link http://docs.moodle.org/dev/Languages/AMOS}) using the
+ * list of strings defined in /install/stringnames.txt.
+ *
+ * @package   installer
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$string['parentlanguage'] = 'lt';
+$string['thislanguage'] = 'Lithuanian (university)';
index 0b9bc61..0116d50 100644 (file)
@@ -106,6 +106,8 @@ $string['currentstage8'] = 'Perform backup';
 $string['currentstage16'] = 'Complete';
 $string['dependenciesenforced'] = 'Your settings have been altered due to unmet dependencies';
 $string['enterasearch'] = 'Enter a search';
+$string['error_block_for_module_not_found'] = 'Orphan block instance (id: {$a->bid}) for course module (id: {$a->mid}) found. This block will not be backed up';
+$string['error_course_module_not_found'] = 'Orphan course module (id: {$a}) found. This module will not be backed up.';
 $string['errorfilenamerequired'] = 'You must enter a valid filename for this backup';
 $string['errorfilenamemustbezip'] = 'The filename you enter must be a ZIP file and have the .mbz extension';
 $string['errorminbackup20version'] = 'This backup file has been created with one development version of Moodle backup ({$a->backup}). Minimum required is {$a->min}. Cannot be restored.';
index b583eff..8d3ae77 100644 (file)
@@ -506,6 +506,8 @@ $string['rawpct'] = 'Raw %';
 $string['real'] = 'Real';
 $string['realletter'] = 'Real (letter)';
 $string['realpercentage'] = 'Real (percentage)';
+$string['recovergradesdefault'] = 'Recover grades default';
+$string['recovergradesdefault_help'] = 'By default recover old grades when re-enrolling a user in a course.';
 $string['regradeanyway'] = 'Regrade anyway';
 $string['removeallcoursegrades'] = 'Delete all grades';
 $string['removeallcourseitems'] = 'Delete all items and categories';
index 4da2ea8..7905f66 100644 (file)
@@ -39,16 +39,16 @@ $string['parentlanguage'] = '';
 $string['strftimedate'] = '%d %B %Y';
 $string['strftimedatefullshort'] = '%d/%m/%y';
 $string['strftimedateshort'] = '%d %B';
-$string['strftimedatetime'] = '%d %B %Y, %l:%M %p';
+$string['strftimedatetime'] = '%d %B %Y, %I:%M %p';
 $string['strftimedatetimeshort'] = '%d/%m/%y, %H:%M';
 $string['strftimedaydate'] = '%A, %d %B %Y';
-$string['strftimedaydatetime'] = '%A, %d %B %Y, %l:%M %p';
+$string['strftimedaydatetime'] = '%A, %d %B %Y, %I:%M %p';
 $string['strftimedayshort'] = '%A, %d %B';
 $string['strftimedaytime'] = '%a, %H:%M';
 $string['strftimemonthyear'] = '%B %Y';
 $string['strftimerecent'] = '%d %b, %H:%M';
-$string['strftimerecentfull'] = '%a, %d %b %Y, %l:%M %p';
-$string['strftimetime'] = '%l:%M %p';
+$string['strftimerecentfull'] = '%a, %d %b %Y, %I:%M %p';
+$string['strftimetime'] = '%I:%M %p';
 $string['thisdirection'] = 'ltr';
 $string['thisdirectionvertical'] = 'btt';
 $string['thislanguage'] = 'English';
index f087849..36cd958 100644 (file)
@@ -179,6 +179,7 @@ $string['profileimportfields'] = 'Fields to import';
 $string['promiscuous'] = 'Promiscuous';
 $string['publickey'] = 'Public key';
 $string['publickey_help'] = 'The public key is automatically obtained from the remote server.';
+$string['publickeyrequired'] = 'You must provide a public key.';
 $string['publish'] = 'Publish';
 $string['reallydeleteserver'] = 'Are you sure you want to delete the server';
 $string['receivedwarnings'] = 'The following warnings were received';
index f7d378f..0d640e4 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
 /**
  * Library functions to facilitate the use of ajax JavaScript in Moodle.
  *
- * @package   moodlecore
+ * @package   core
  * @copyright 2009 Tim Hunt
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 /**
- * You need to call this function if you wish to use the set_user_preference
- * method in javascript_static.php, to white-list the preference you want to update
- * from JavaScript, and to specify the type of cleaning you expect to be done on
- * values.
+ * You need to call this function if you wish to use the set_user_preference method in javascript_static.php, to white-list the
+ * preference you want to update from JavaScript, and to specify the type of cleaning you expect to be done on values.
  *
- * @param string $name the name of the user_perference we should allow to be
- *      updated by remote calls.
- * @param integer $paramtype one of the PARAM_{TYPE} constants, user to clean
- *      submitted values before set_user_preference is called.
- * @return void
+ * @package  core
+ * @category preference
+ * @param    string          $name      the name of the user_perference we should allow to be updated by remote calls.
+ * @param    integer         $paramtype one of the PARAM_{TYPE} constants, user to clean submitted values before set_user_preference is called.
+ * @return   null
  */
 function user_preference_allow_ajax_update($name, $paramtype) {
     global $USER, $PAGE;
index d00bef9..6891a30 100644 (file)
@@ -20,7 +20,7 @@
  * in XML format back to a page from an AJAX call
  *
  * @since 2.0
- * @package moodlecore
+ * @package core
  * @copyright 2009 Sam Hemelryk
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
index ca94ccb..d4b819d 100644 (file)
@@ -1,35 +1,29 @@
 <?php
-
-///////////////////////////////////////////////////////////////////////////
-//                                                                       //
-// NOTICE OF COPYRIGHT                                                   //
-//                                                                       //
-// Moodle - Modular Object-Oriented Dynamic Learning Environment         //
-//          http://moodle.org                                            //
-//                                                                       //
-// Copyright (C) 1999 onwards Martin Dougiamas  http://dougiamas.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                         //
-//                                                                       //
-///////////////////////////////////////////////////////////////////////////
+// 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/>.
 
 /**
- * Code to update a user preference in response to an ajax call. You should not
- * send requests to this script directly. Instead use the set_user_preference
+ * Code to update a user preference in response to an ajax call.
+ *
+ * You should not send requests to this script directly. Instead use the set_user_preference
  * function in javascript_static.js.
  *
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package moodlecore
+ * @package    core
+ * @category   preference
+ * @copyright  2008 Tim Hunt
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once(dirname(__FILE__) . '/../../config.php');
index 657814d..81c5a91 100644 (file)
         <FIELD NAME="subject" TYPE="char" LENGTH="128" NOTNULL="true" SEQUENCE="false" PREVIOUS="coursemoduleid" NEXT="summary"/>
         <FIELD NAME="summary" TYPE="text" LENGTH="big" NOTNULL="false" SEQUENCE="false" PREVIOUS="subject" NEXT="content"/>
         <FIELD NAME="content" TYPE="text" LENGTH="big" NOTNULL="false" SEQUENCE="false" PREVIOUS="summary" NEXT="uniquehash"/>
-        <FIELD NAME="uniquehash" TYPE="char" LENGTH="128" NOTNULL="true" SEQUENCE="false" PREVIOUS="content" NEXT="rating"/>
+        <FIELD NAME="uniquehash" TYPE="char" LENGTH="255" NOTNULL="true" SEQUENCE="false" PREVIOUS="content" NEXT="rating"/>
         <FIELD NAME="rating" TYPE="int" LENGTH="10" NOTNULL="true" UNSIGNED="true" DEFAULT="0" SEQUENCE="false" PREVIOUS="uniquehash" NEXT="format"/>
         <FIELD NAME="format" TYPE="int" LENGTH="10" NOTNULL="true" UNSIGNED="true" DEFAULT="0" SEQUENCE="false" PREVIOUS="rating" NEXT="summaryformat"/>
         <FIELD NAME="summaryformat" TYPE="int" LENGTH="2" NOTNULL="true" UNSIGNED="true" DEFAULT="0" SEQUENCE="false" PREVIOUS="format" NEXT="attachment"/>
index 2c28ba3..df9b3f8 100644 (file)
@@ -145,6 +145,48 @@ function xmldb_main_upgrade($oldversion) {
         upgrade_main_savepoint(true, 2012020200.06);
     }
 
+    if ($oldversion < 2012021700.01) {
+        // Changing precision of field uniquehash on table post to 255
+        $table = new xmldb_table('post');
+        $field = new xmldb_field('uniquehash', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null, 'content');
+
+        // Launch change of precision for field uniquehash
+        $dbman->change_field_precision($table, $field);
+
+        // Main savepoint reached
+        upgrade_main_savepoint(true, 2012021700.01);
+    }
+
+    if ($oldversion < 2012021700.02) {
+        // Somewhere before 1.9 summary and content column in post table were not null. In 1.9+
+        // not null became false.
+        $columns = $DB->get_columns('post');
+
+        // Fix discrepancies in summary field after upgrade from 1.9
+        if (array_key_exists('summary', $columns) && $columns['summary']->not_null != false) {
+            $table = new xmldb_table('post');
+            $summaryfield = new xmldb_field('summary', XMLDB_TYPE_TEXT, 'big', null, null, null, null, 'subject');
+
+            if ($dbman->field_exists($table, $summaryfield)) {
+                $dbman->change_field_notnull($table, $summaryfield);
+            }
+
+        }
+
+        // Fix discrepancies in content field after upgrade from 1.9
+        if (array_key_exists('content', $columns) && $columns['content']->not_null != false) {
+            $table = new xmldb_table('post');
+            $contentfield = new xmldb_field('content', XMLDB_TYPE_TEXT, 'big', null, null, null, null, 'summary');
+
+            if ($dbman->field_exists($table, $contentfield)) {
+                $dbman->change_field_notnull($table, $contentfield);
+            }
+
+        }
+
+        upgrade_main_savepoint(true, 2012021700.02);
+    }
+
     return true;
 }
 
index e7e1987..a6c762a 100644 (file)
@@ -20,6 +20,7 @@
  * Database column information.
  *
  * @package    core
+ * @category   dml
  * @subpackage dml
  * @copyright  2008 Petr Skoda (http://skodak.org)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 defined('MOODLE_INTERNAL') || die();
 
 /**
- * Detail database field information.
- * Based on ADOFieldObject.
+ * Detailed database field information.
+ *
+ * It is based on the adodb library's ADOFieldObject object.
+ * 'column' does mean 'the field' here.
+ *
+ * @package core
+ * @category dml
+ * @copyright 2008 Petr Skoda (http://skodak.org)
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class database_column_info {
     /**
-     * Name of column - lowercase
+     * Name of column - lowercase.
+     * @var string
      */
     public $name;
 
     /**
-     * Driver dependent native data type
-     * Not standardised - used to find meta_type
+     * Driver dependent native data type.
+     * Not standardised, its used to find meta_type.
+     * @var string
      */
     public $type;
 
@@ -51,6 +61,7 @@ class database_column_info {
      *  float - digits left from floating point
      *  boolean - 1
      *  enums - null
+     * @var int
      */
     public $max_length;
 
@@ -58,6 +69,7 @@ class database_column_info {
      * Scale
      * float - decimal points
      * other - null
+     * @var int
      */
     public $scale;
 
@@ -67,54 +79,63 @@ class database_column_info {
      *
      * For performance reasons this field is optional!
      * You can use DDL sql_generator::getCheckConstraintsFromDB() if needed.
+     * @var string
      */
     public $enums;
 
     /**
      * True if not null, false otherwise
+     * @var bool
      */
     public $not_null;
 
     /**
      * True if column is primary key.
      * (usually 'id').
+     * @var bool
      */
     public $primary_key;
 
     /**
      * True if filed autoincrementing
      * (usually 'id' only)
+     * @var bool
      */
     public $auto_increment;
 
     /**
      * True if binary
+     * @var bool
      */
     public $binary;
 
     /**
      * True if integer unsigned, false if signed.
      * Null for other types
+     * @var integer
      */
     public $unsigned;
 
     /**
-     * True if default value defined
+     * True if the default value is defined.
+     * @var bool
      */
     public $has_default;
 
     /**
-     * Default value if defined
+     * The default value (if defined).
+     * @var string
      */
     public $default_value;
 
     /**
-     * True if field values unique, false if not
+     * True if field values are unique, false if not.
+     * @var bool
      */
     public $unique;
 
     /**
-     * Standardised one character column type, uppercase
+     * Standardised one character column type, uppercased and enumerated as follows:
      * R - counter (integer primary key)
      * I - integers
      * N - numbers (floats)
@@ -124,12 +145,13 @@ class database_column_info {
      * L - boolean (1 bit)
      * T - timestamp - unsupported
      * D - date - unsupported
+     * @var string
      */
     public $meta_type;
 
     /**
      * Constructor
-     * @param $data mixed object or array with properties
+     * @param mixed $data object or array with properties
      */
     public function __construct($data) {
         foreach ($data as $key=>$value) {
index 6e00b4c..88309a4 100644 (file)
 /**
  * Abstract database driver class.
  *
- * @package    core
+ * @package core
+ * @category dml
  * @subpackage dml
- * @copyright  2008 Petr Skoda (http://skodak.org)
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright 2008 Petr Skoda (http://skodak.org)
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 defined('MOODLE_INTERNAL') || die();
@@ -33,61 +34,66 @@ require_once($CFG->libdir.'/dml/moodle_transaction.php');
 
 /// GLOBAL CONSTANTS /////////////////////////////////////////////////////////
 
-/** Bitmask, indicates :name type parameters are supported by db backend. */
+/** SQL_PARAMS_NAMED - Bitmask, indicates :name type parameters are supported by db backend. */
 define('SQL_PARAMS_NAMED', 1);
 
-/** Bitmask, indicates ? type parameters are supported by db backend. */
+/** SQL_PARAMS_QM - Bitmask, indicates ? type parameters are supported by db backend. */
 define('SQL_PARAMS_QM', 2);
 
-/** Bitmask, indicates $1, $2, ... type parameters are supported by db backend. */
+/** SQL_PARAMS_DOLLAR - Bitmask, indicates $1, $2, ... type parameters are supported by db backend. */
 define('SQL_PARAMS_DOLLAR', 4);
 
-
-/** Normal select query, reading only */
+/** SQL_QUERY_SELECT - Normal select query, reading only. */
 define('SQL_QUERY_SELECT', 1);
 
-/** Insert select query, writing */
+/** SQL_QUERY_INSERT - Insert select query, writing. */
 define('SQL_QUERY_INSERT', 2);
 
-/** Update select query, writing */
+/** SQL_QUERY_UPDATE - Update select query, writing. */
 define('SQL_QUERY_UPDATE', 3);
 
-/** Query changing db structure, writing */
+/** SQL_QUERY_STRUCTURE - Query changing db structure, writing. */
 define('SQL_QUERY_STRUCTURE', 4);
 
-/** Auxiliary query done by driver, setting connection config, getting table info, etc. */
+/** SQL_QUERY_AUX - Auxiliary query done by driver, setting connection config, getting table info, etc. */
 define('SQL_QUERY_AUX', 5);
 
 /**
  * Abstract class representing moodle database interface.
+ * @link http://docs.moodle.org/dev/DML_functions
+ *
+ * @package    core
+ * @category   dml
+ * @copyright  2008 Petr Skoda (http://skodak.org)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 abstract class moodle_database {
 
-    /** @var database_manager db manager which allows db structure modifications */
+    /** @var database_manager db manager which allows db structure modifications. */
     protected $database_manager;
-    /** @var moodle_temptables temptables manager to provide cross-db support for temp tables */
+    /** @var moodle_temptables temptables manager to provide cross-db support for temp tables. */
     protected $temptables;
-    /** @var array cache of column info */
+    /** @var array Cache of column info. */
     protected $columns = array(); // I wish we had a shared memory cache for this :-(
-    /** @var array cache of table info */
+    /** @var array Cache of table info. */
     protected $tables  = null;
 
     // db connection options
-    /** @var string db host name */
+    /** @var string db host name. */
     protected $dbhost;
-    /** @var string db host user */
+    /** @var string db host user. */
     protected $dbuser;
-    /** @var string db host password */
+    /** @var string db host password. */
     protected $dbpass;
-    /** @var string db name */
+    /** @var string db name. */
     protected $dbname;
-    /** @var string table prefix */
+    /** @var string Prefix added to table names. */
     protected $prefix;
 
-    /** @var array Database or driver specific options, such as sockets or TCPIP db connections */
+    /** @var array Database or driver specific options, such as sockets or TCPIP db connections. */
     protected $dboptions;
 
-    /** @var bool true means non-moodle external database used.*/
+    /** @var bool True means non-moodle external database used.*/
     protected $external;
 
     /** @var int The database reads (performance counter).*/
@@ -95,39 +101,43 @@ abstract class moodle_database {
     /** @var int The database writes (performance counter).*/
     protected $writes = 0;
 
-    /** @var int Debug level */
+    /** @var int Debug level. */
     protected $debug  = 0;
 
-    /** @var string last query sql */
+    /** @var string Last used query sql. */
     protected $last_sql;
-    /** @var array last query parameters */
+    /** @var array Last query parameters. */
     protected $last_params;
-    /** @var int last query type */
+    /** @var int Last query type. */
     protected $last_type;
-    /** @var string last extra info */
+    /** @var string Last extra info. */
     protected $last_extrainfo;
-    /** @var float last time in seconds with millisecond precision */
+    /** @var float Last time in seconds with millisecond precision. */
     protected $last_time;
-    /** @var bool flag indicating logging of query in progress, prevents infinite loops */
+    /** @var bool Flag indicating logging of query in progress. This helps prevent infinite loops. */
     private $loggingquery = false;
 
-    /** @var bool true if db used for db sessions */
+    /** @var bool True if the db is used for db sessions. */
     protected $used_for_db_sessions = false;
 
-    /** @var array open transactions */
+    /** @var array Array containing open transactions. */
     private $transactions = array();
-    /** @var bool force rollback of all current transactions */
+    /** @var bool Flag used to force rollback of all current transactions. */
     private $force_rollback = false;
 
-    /** @var int internal temporary variable */
+    /**
+     * @var int internal temporary variable used to fix params. Its used by {@link _fix_sql_params_dollar_callback()}.
+     */
     private $fix_sql_params_i;
-    /** @var int internal temporary variable used by {@link get_in_or_equal()}. */
-    private $inorequaluniqueindex = 1; // guarantees unique parameters in each request
+    /**
+     * @var int internal temporary variable used to guarantee unique parameters in each request. Its used by {@link get_in_or_equal()}.
+     */
+    private $inorequaluniqueindex = 1;
 
     /**
-     * Constructor - instantiates the database, specifying if it's external (connect to other systems) or no (Moodle DB)
-     *              note this has effect to decide if prefix checks must be performed or no
-     * @param bool true means external database used
+     * Constructor - Instantiates the database, specifying if it's external (connect to other systems) or not (Moodle DB).
+     *              Note that this affects the decision of whether prefix checks must be performed or not.
+     * @param bool $external True means that an external database is used.
      */
     public function __construct($external=false) {
         $this->external  = $external;
@@ -141,16 +151,16 @@ abstract class moodle_database {
     }
 
     /**
-     * Detects if all needed PHP stuff installed.
+     * Detects if all needed PHP stuff are installed for DB connectivity.
      * Note: can be used before connect()
-     * @return mixed true if ok, string if something
+     * @return mixed True if requirements are met, otherwise a string if something isn't installed.
      */
     public abstract function driver_installed();
 
     /**
      * Returns database table prefix
      * Note: can be used before connect()
-     * @return string database table prefix
+     * @return string The prefix used in the database.
      */
     public function get_prefix() {
         return $this->prefix;
@@ -158,10 +168,13 @@ abstract class moodle_database {
 
     /**
      * Loads and returns a database instance with the specified type and library.
-     * @param string $type database type of the driver (mysqli, pgsql, mssql, sqldrv, oci, etc.)
-     * @param string $library database library of the driver (native, pdo, etc.)
-     * @param boolean $external true if this is an external database
-     * @return moodle_database driver object or null if error
+     *
+     * The loaded class is within lib/dml directory and of the form: $type.'_'.$library.'_moodle_database'
+     *
+     * @param string $type Database driver's type. (eg: mysqli, pgsql, mssql, sqldrv, oci, etc.)
+     * @param string $library Database driver's library (native, pdo, etc.)
+     * @param bool $external True if this is an external database.
+     * @return moodle_database driver object or null if error, for example of driver object see {@link mysqli_native_moodle_database}
      */
     public static function get_driver_instance($type, $library, $external = false) {
         global $CFG;
@@ -178,50 +191,50 @@ abstract class moodle_database {
     }
 
     /**
-     * Returns database family type - describes SQL dialect
+     * Returns the database family type. (This sort of describes the SQL 'dialect')
      * Note: can be used before connect()
-     * @return string db family name (mysql, postgres, mssql, oracle, etc.)
+     * @return string The db family name (mysql, postgres, mssql, oracle, etc.)
      */
     public abstract function get_dbfamily();
 
     /**
-     * Returns more specific database driver type
+     * Returns more specific database driver type
      * Note: can be used before connect()
-     * @return string db type mysqli, pgsql, oci, mssql, sqlsrv
+     * @return string The db type mysqli, pgsql, oci, mssql, sqlsrv
      */
     protected abstract function get_dbtype();
 
     /**
-     * Returns general database library name
+     * Returns the general database library name
      * Note: can be used before connect()
-     * @return string db type pdo, native
+     * @return string The db library type -  pdo, native etc.
      */
     protected abstract function get_dblibrary();
 
     /**
-     * Returns localised database type name
+     * Returns the localised database type name
      * Note: can be used before connect()
      * @return string
      */
     public abstract function get_name();
 
     /**
-     * Returns localised database configuration help.
+     * Returns the localised database configuration help.
      * Note: can be used before connect()
      * @return string
      */
     public abstract function get_configuration_help();
 
     /**
-     * Returns localised database description
+     * Returns the localised database description
      * Note: can be used before connect()
      * @return string
      */
     public abstract function get_configuration_hints();
 
     /**
-     * Returns db related part of config.php
-     * @return object
+     * Returns the db related part of config.php
+     * @return stdClass
      */
     public function export_dbconfig() {
         $cfg = new stdClass();
@@ -250,12 +263,12 @@ abstract class moodle_database {
     }
 
     /**
-     * Connect to db
+     * Connects to the database.
      * Must be called before other methods.
-     * @param string $dbhost
-     * @param string $dbuser
-     * @param string $dbpass
-     * @param string $dbname
+     * @param string $dbhost The database host.
+     * @param string $dbuser The database user to connect as.
+     * @param string $dbpass The password to use when connecting to the database.
+     * @param string $dbname The name of the database being connected to.
      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
      * @param array $dboptions driver specific options
      * @return bool true
@@ -265,10 +278,10 @@ abstract class moodle_database {
 
     /**
      * Store various database settings
-     * @param string $dbhost
-     * @param string $dbuser
-     * @param string $dbpass
-     * @param string $dbname
+     * @param string $dbhost The database host.
+     * @param string $dbuser The database user to connect as.
+     * @param string $dbpass The password to use when connecting to the database.
+     * @param string $dbname The name of the database being connected to.
      * @param mixed $prefix string means moodle db prefix, false used for external databases where prefix not used
      * @param array $dboptions driver specific options
      * @return void
@@ -284,19 +297,20 @@ abstract class moodle_database {
 
     /**
      * Attempt to create the database
-     * @param string $dbhost
-     * @param string $dbuser
-     * @param string $dbpass
-     * @param string $dbname
+     * @param string $dbhost The database host.
+     * @param string $dbuser The database user to connect as.
+     * @param string $dbpass The password to use when connecting to the database.
+     * @param string $dbname The name of the database being connected to.
+     * @param array $dboptions An array of optional database options (eg: dbport)
      *
-     * @return bool success
+     * @return bool success True for successful connection. False otherwise.
      */
     public function create_database($dbhost, $dbuser, $dbpass, $dbname, array $dboptions=null) {
         return false;
     }
 
     /**
-     * Close database connection and release all resources
+     * Closes the database connection and releases all resources
      * and memory (especially circular memory references).
      * Do NOT use connect() again, create a new instance if needed.
      * @return void
@@ -331,11 +345,11 @@ abstract class moodle_database {
     }
 
     /**
-     * Called before each db query.
-     * @param string $sql
-     * @param array array of parameters
-     * @param int $type type of query
-     * @param mixed $extrainfo driver specific extra information
+     * This should be called before each db query.
+     * @param string $sql The query string.
+     * @param array $params An array of parameters.
+     * @param int $type The type of query. ( SQL_QUERY_SELECT | SQL_QUERY_AUX | SQL_QUERY_INSERT | SQL_QUERY_UPDATE | SQL_QUERY_STRUCTURE )
+     * @param mixed $extrainfo This is here for any driver specific extra information.
      * @return void
      */
     protected function query_start($sql, array $params=null, $type, $extrainfo=null) {
@@ -363,8 +377,10 @@ abstract class moodle_database {
     }
 
     /**
-     * Called immediately after each db query.
-     * @param mixed db specific result
+     * This should be called immediately after each db query. It does a clean up of resources.
+     * It also throws exceptions if the sql that ran produced errors.
+     * @param mixed $result The db specific result obtained from running a query.
+     * @throws dml_read_exception | dml_write_exception | ddl_change_structure_exception
      * @return void
      */
     protected function query_end($result) {
@@ -402,7 +418,7 @@ abstract class moodle_database {
     }
 
     /**
-     * Log last database query if requested
+     * This logs the last query based on 'logall', 'logslow' and 'logerrors' options configured via $CFG->dboptions .
      * @param mixed string error or false if not error
      * @return void
      */
@@ -444,27 +460,27 @@ abstract class moodle_database {
 
     /**
      * Returns database server info array
-     * @return array
+     * @return array Array containing 'description' and 'version' atleast.
      */
     public abstract function get_server_info();
 
     /**
      * Returns supported query parameter types
-     * @return int bitmask
+     * @return int bitmask of accepted SQL_PARAMS_*
      */
     protected abstract function allowed_param_types();
 
     /**
-     * Returns last error reported by database engine.
-     * @return string error message
+     * Returns the last error reported by the database engine.
+     * @return string The error message.
      */
     public abstract function get_last_error();
 
     /**
-     * Print sql debug info
-     * @param string $sql query which caused problems
-     * @param array $params optional query parameters
-     * @param mixed $obj optional library specific object
+     * Prints sql debug info
+     * @param string $sql The query which is being debugged.
+     * @param array $params The query parameters. (optional)
+     * @param mixed $obj The library specific object. (optional)
      * @return void
      */
     protected function print_debug($sql, array $params=null, $obj=null) {
@@ -489,10 +505,11 @@ abstract class moodle_database {
     }
 
     /**
-     * Returns SQL WHERE conditions.
-     * @param string $table - the table name that these conditions will be validated against.
-     * @param array conditions - must not contain numeric indexes
-     * @return array sql part and params
+     * Returns the SQL WHERE conditions.
+     * @param string $table The table name that these conditions will be validated against.
+     * @param array $conditions The conditions to build the where clause. (must not contain numeric indexes)
+     * @throws dml_exception
+     * @return array An array list containing sql 'where' part and 'params'.
      */
     protected function where_clause($table, array $conditions=null) {
         // We accept nulls in conditions
@@ -553,11 +570,11 @@ abstract class moodle_database {
     }
 
     /**
-     * Returns SQL WHERE conditions for the ..._list methods.
+     * Returns SQL WHERE conditions for the ..._list group of methods.
      *
      * @param string $field the name of a field.
      * @param array $values the values field might take.
-     * @return array sql part and params
+     * @return array An array containing sql 'where' part and 'params'
      */
     protected function where_clause_list($field, array $values) {
         $params = array();
@@ -579,14 +596,15 @@ abstract class moodle_database {
     }
 
     /**
-     * Constructs IN() or = sql fragment
-     * @param mixed $items single or array of values
-     * @param int $type bound param type SQL_PARAMS_QM or SQL_PARAMS_NAMED
-     * @param string $prefix named parameter placeholder prefix (unique counter value is appended to each parameter name)
-     * @param bool $equal true means equal, false not equal
-     * @param mixed $onemptyitems defines the behavior when the array of items is empty. Defaults to false,
+     * Constructs 'IN()' or '=' sql fragment
+     * @param mixed $items A single value or array of values for the expression.
+     * @param int $type Parameter bounding type : SQL_PARAMS_QM or SQL_PARAMS_NAMED.
+     * @param string $prefix Named parameter placeholder prefix (a unique counter value is appended to each parameter name).
+     * @param bool $equal True means we want to equate to the constructed expression, false means we don't want to equate to it.
+     * @param mixed $onemptyitems This defines the behavior when the array of items provided is empty. Defaults to false,
      *              meaning throw exceptions. Other values will become part of the returned SQL fragment.
-     * @return array - $sql and $params
+     * @throws coding_exception | dml_exception
+     * @return array A list containing the constructed sql fragment and an array of parameters.
      */
     public function get_in_or_equal($items, $type=SQL_PARAMS_QM, $prefix='param', $equal=true, $onemptyitems=false) {
 
@@ -654,15 +672,19 @@ abstract class moodle_database {
     }
 
     /**
-     * Converts short table name {tablename} to real table name
-     * @param string sql
-     * @return string sql
+     * Converts short table name {tablename} to the real prefixed table name in given sql.
+     * @param string $sql The sql to be operated on.
+     * @return string The sql with tablenames being prefixed with $CFG->prefix
      */
     protected function fix_table_names($sql) {
         return preg_replace('/\{([a-z][a-z0-9_]*)\}/', $this->prefix.'$1', $sql);
     }
 
-    /** Internal function */
+    /**
+     * Internal private utitlity function used to fix parameters.
+     * Used with {@link preg_replace_callback()}
+     * @param array $match Refer to preg_replace_callback usage for description.
+     */
     private function _fix_sql_params_dollar_callback($match) {
         $this->fix_sql_params_i++;
         return "\$".$this->fix_sql_params_i;
@@ -670,8 +692,8 @@ abstract class moodle_database {
 
     /**
      * Normalizes sql query parameters and verifies parameters.
-     * @param string $sql query or part of it
-     * @param array $params query parameters
+     * @param string $sql The query or part of it.
+     * @param array $params The query parameters.
      * @return array (sql, params, type of params)
      */
     public function fix_sql_params($sql, array $params=null) {
@@ -822,27 +844,29 @@ abstract class moodle_database {
     }
 
     /**
-     * Return tables in database WITHOUT current prefix
+     * Return tables in database WITHOUT current prefix.
+     * @param bool $usecache if true, returns list of cached tables.
      * @return array of table names in lowercase and without prefix
      */
     public abstract function get_tables($usecache=true);
 
     /**
-     * Return table indexes - everything lowercased
-     * @return array of arrays
+     * Return table indexes - everything lowercased.
+     * @param string $table The table we want to get indexes from.
+     * @return array An associative array of indexes containing 'unique' flag and 'columns' being indexed
      */
     public abstract function get_indexes($table);
 
     /**
      * Returns detailed information about columns in table. This information is cached internally.
-     * @param string $table name
-     * @param bool $usecache
+     * @param string $table The table's name.
+     * @param bool $usecache Flag to use internal cacheing. The default is true.
      * @return array of database_column_info objects indexed with column names
      */
     public abstract function get_columns($table, $usecache=true);
 
     /**
-     * Normalise values based in RDBMS dependencies (booleans, LOBs...)
+     * Normalise values based on varying RDBMS's dependencies (booleans, LOBs...)
      *
      * @param database_column_info $column column metadata corresponding with the value we are going to normalise
      * @param mixed $value value we are going to normalise
@@ -851,8 +875,7 @@ abstract class moodle_database {
     protected abstract function normalise_value($column, $value);
 
     /**
-     * Reset internal column details cache
-     * @param string $table - empty means all, or one if name of table given
+     * Resets the internal column details cache
      * @return void
      */
     public function reset_caches() {
@@ -861,9 +884,10 @@ abstract class moodle_database {
     }
 
     /**
-     * Returns sql generator used for db manipulation.
+     * Returns the sql generator used for db manipulation.
      * Used mostly in upgrade.php scripts.
-     * @return database_manager instance
+     * @return database_manager The instance used to perform ddl operations.
+     * @see lib/ddl/database_manager.php
      */
     public function get_manager() {
         global $CFG;
@@ -881,15 +905,15 @@ abstract class moodle_database {
     }
 
     /**
-     * Attempt to change db encoding toUTF-8 if possible
-     * @return bool success
+     * Attempts to change db encoding to UTF-8 encoding if possible.
+     * @return bool True is successful.
      */
     public function change_db_encoding() {
         return false;
     }
 
     /**
-     * Is db in unicode mode?
+     * Checks to see if the database is in unicode mode?
      * @return bool
      */
     public function setup_is_unicodedb() {
@@ -897,7 +921,7 @@ abstract class moodle_database {
     }
 
     /**
-     * Enable/disable very detailed debugging
+     * Enable/disable very detailed debugging.
      * @param bool $state
      * @return void
      */
@@ -923,20 +947,20 @@ abstract class moodle_database {
     }
 
     /**
-     * Do NOT use in code, to be used by database_manager only!
+     * Do NOT use in code, this is for use by database_manager only!
      * @param string $sql query
      * @return bool true
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public abstract function change_database_structure($sql);
 
     /**
-     * Execute general sql query. Should be used only when no other method suitable.
+     * Executes a general sql query. Should be used only when no other method suitable.
      * Do NOT use this to make changes in db structure, use database_manager::execute_sql() instead!
      * @param string $sql query
      * @param array $params query parameters
      * @return bool true
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public abstract function execute($sql, array $params=null);
 
@@ -969,10 +993,10 @@ abstract class moodle_database {
      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
-     * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
+     * @param int $limitfrom return a subset of records, starting at this point (optional).
      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
-     * @return moodle_recordset instance
-     * @throws dml_exception if error
+     * @return moodle_recordset A moodle_recordset instance
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_recordset($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
         list($select, $params) = $this->where_clause($table, $conditions);
@@ -985,17 +1009,17 @@ abstract class moodle_database {
      * Only records where $field takes one of the values $values are returned.
      * $values must be an array of values.
      *
-     * Other arguments and the return type as for @see function get_recordset.
+     * Other arguments and the return type are like {@link function get_recordset}.
      *
      * @param string $table the table to query.
      * @param string $field a field to check (optional).
      * @param array $values array of values the field must have
      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
-     * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
+     * @param int $limitfrom return a subset of records, starting at this point (optional).
      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
-     * @return moodle_recordset instance
-     * @throws dml_exception if error
+     * @return moodle_recordset A moodle_recordset instance.
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_recordset_list($table, $field, array $values, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
         list($select, $params) = $this->where_clause_list($field, $values);
@@ -1012,17 +1036,17 @@ abstract class moodle_database {
      * If given, $select is used as the SELECT parameter in the SQL query,
      * otherwise all records from the table are returned.
      *
-     * Other arguments and the return type as for @see function get_recordset.
+     * Other arguments and the return type are like {@link function get_recordset}.
      *
      * @param string $table the table to query.
      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
      * @param array $params array of sql parameters
      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
      * @param string $fields a comma separated list of fields to return (optional, by default all fields are returned).
-     * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
+     * @param int $limitfrom return a subset of records, starting at this point (optional).
      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
-     * @return moodle_recordset instance
-     * @throws dml_exception if error
+     * @return moodle_recordset A moodle_recordset instance.
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_recordset_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
         $sql = "SELECT $fields FROM {".$table."}";
@@ -1042,14 +1066,14 @@ abstract class moodle_database {
      * code where it's possible there might be large datasets being returned.  For known
      * small datasets use get_records_sql - it leads to simpler code.
      *
-     * The return type is as for @see function get_recordset.
+     * The return type is like {@link function get_recordset}.
      *
      * @param string $sql the SQL select query to execute.
      * @param array $params array of sql parameters
-     * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
+     * @param int $limitfrom return a subset of records, starting at this point (optional).
      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
-     * @return moodle_recordset instance
-     * @throws dml_exception if error
+     * @return moodle_recordset A moodle_recordset instance.
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public abstract function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);
 
@@ -1068,10 +1092,10 @@ abstract class moodle_database {
      * @param string $fields a comma separated list of fields to return (optional, by default
      *   all fields are returned). The first field will be used as key for the
      *   array so must be a unique field such as 'id'.
-     * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
-     * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
-     * @return array of objects indexed by first column
-     * @throws dml_exception if error
+     * @param int $limitfrom return a subset of records, starting at this point (optional).
+     * @param int $limitnum return a subset comprising this many records in total (optional, required if $limitfrom is set).
+     * @return array An array of Objects indexed by first column.
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_records($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
         list($select, $params) = $this->where_clause($table, $conditions);
@@ -1081,17 +1105,17 @@ abstract class moodle_database {
     /**
      * Get a number of records as an array of objects where one field match one list of values.
      *
-     * Return value as for @see function get_records.
+     * Return value is like {@link function get_records}.
      *
      * @param string $table The database table to be checked against.
      * @param string $field The field to search
-     * @param string $values array of values
+     * @param array $values An array of values
      * @param string $sort Sort order (as valid SQL sort parameter)
      * @param string $fields A comma separated list of fields to be returned from the chosen table. If specified,
      *   the first field should be a unique one such as 'id' since it will be used as a key in the associative
      *   array.
-     * @return array of objects indexed by first column
-     * @throws dml_exception if error
+     * @return array An array of objects indexed by first column
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_records_list($table, $field, array $values, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
         list($select, $params) = $this->where_clause_list($field, $values);
@@ -1105,19 +1129,19 @@ abstract class moodle_database {
     /**
      * Get a number of records as an array of objects which match a particular WHERE clause.
      *
-     * Return value as for @see function get_records.
+     * Return value is like {@link function get_records}.
      *
-     * @param string $table the table to query.
+     * @param string $table The table to query.
      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
-     * @param array $params array of sql parameters
-     * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
-     * @param string $fields a comma separated list of fields to return
+     * @param array $params An array of sql parameters
+     * @param string $sort An order to sort the results in (optional, a valid SQL ORDER BY parameter).
+     * @param string $fields A comma separated list of fields to return
      *   (optional, by default all fields are returned). The first field will be used as key for the
      *   array so must be a unique field such as 'id'.
-     * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
-     * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
+     * @param int $limitfrom return a subset of records, starting at this point (optional).
+     * @param int $limitnum return a subset comprising this many records in total (optional, required if $limitfrom is set).
      * @return array of objects indexed by first column
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_records_select($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
         if ($select) {
@@ -1132,23 +1156,23 @@ abstract class moodle_database {
     /**
      * Get a number of records as an array of objects using a SQL statement.
      *
-     * Return value as for @see function get_records.
+     * Return value is like {@link function get_records}.
      *
      * @param string $sql the SQL select query to execute. The first column of this SELECT statement
      *   must be a unique value (usually the 'id' field), as it will be used as the key of the
      *   returned array.
      * @param array $params array of sql parameters
-     * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
-     * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
+     * @param int $limitfrom return a subset of records, starting at this point (optional).
+     * @param int $limitnum return a subset comprising this many records in total (optional, required if $limitfrom is set).
      * @return array of objects indexed by first column
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public abstract function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0);
 
     /**
      * Get the first two columns from a number of records as an associative array where all the given conditions met.
      *
-     * Arguments as for @see function get_recordset.
+     * Arguments are like {@link function get_recordset}.
      *
      * If no errors occur the return value
      * is an associative whose keys come from the first field of each record,
@@ -1159,10 +1183,10 @@ abstract class moodle_database {
      * @param array $conditions optional array $fieldname=>requestedvalue with AND in between
      * @param string $sort an order to sort the results in (optional, a valid SQL ORDER BY parameter).
      * @param string $fields a comma separated list of fields to return - the number of fields should be 2!
-     * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
+     * @param int $limitfrom return a subset of records, starting at this point (optional).
      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
      * @return array an associative array
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_records_menu($table, array $conditions=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
         $menu = array();
@@ -1180,18 +1204,18 @@ abstract class moodle_database {
     /**
      * Get the first two columns from a number of records as an associative array which match a particular WHERE clause.
      *
-     * Arguments as for @see function get_recordset_select.
-     * Return value as for @see function get_records_menu.
+     * Arguments are like {@link function get_recordset_select}.
+     * Return value is like {@link function get_records_menu}.
      *
      * @param string $table The database table to be checked against.
      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
      * @param array $params array of sql parameters
      * @param string $sort Sort order (optional) - a valid SQL order parameter
      * @param string $fields A comma separated list of fields to be returned from the chosen table - the number of fields should be 2!
-     * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
+     * @param int $limitfrom return a subset of records, starting at this point (optional).
      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
      * @return array an associative array
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_records_select_menu($table, $select, array $params=null, $sort='', $fields='*', $limitfrom=0, $limitnum=0) {
         $menu = array();
@@ -1209,15 +1233,15 @@ abstract class moodle_database {
     /**
      * Get the first two columns from a number of records as an associative array using a SQL statement.
      *
-     * Arguments as for @see function get_recordset_sql.
-     * Return value as for @see function get_records_menu.
+     * Arguments are like {@link function get_recordset_sql}.
+     * Return value is like {@link function get_records_menu}.
      *
      * @param string $sql The SQL string you wish to be executed.
      * @param array $params array of sql parameters
-     * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
+     * @param int $limitfrom return a subset of records, starting at this point (optional).
      * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
      * @return array an associative array
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_records_sql_menu($sql, array $params=null, $limitfrom=0, $limitnum=0) {
         $menu = array();
@@ -1240,9 +1264,11 @@ abstract class moodle_database {
      * @param string $fields A comma separated list of fields to be returned from the chosen table.
      * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
-     *                        MUST_EXIST means throw exception if no record or multiple records found
+     *                        MUST_EXIST means we will throw an exception if no record or multiple records found.
+     *
+     * @todo MDL-30407 MUST_EXIST option should not throw a dml_exception, it should throw a different exception as it's a requested check.
      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_record($table, array $conditions, $fields='*', $strictness=IGNORE_MISSING) {
         list($select, $params) = $this->where_clause($table, $conditions);
@@ -1259,7 +1285,7 @@ abstract class moodle_database {
      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
      *                        MUST_EXIST means throw exception if no record or multiple records found
      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_record_select($table, $select, array $params=null, $fields='*', $strictness=IGNORE_MISSING) {
         if ($select) {
@@ -1285,7 +1311,7 @@ abstract class moodle_database {
      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
      *                        MUST_EXIST means throw exception if no record or multiple records found
      * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_record_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
         $strictness = (int)$strictness; // we support true/false for BC reasons too
@@ -1323,7 +1349,7 @@ abstract class moodle_database {
      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
      *                        MUST_EXIST means throw exception if no record or multiple records found
      * @return mixed the specified value false if not found
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_field($table, $return, array $conditions, $strictness=IGNORE_MISSING) {
         list($select, $params) = $this->where_clause($table, $conditions);
@@ -1341,7 +1367,7 @@ abstract class moodle_database {
      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
      *                        MUST_EXIST means throw exception if no record or multiple records found
      * @return mixed the specified value false if not found
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_field_select($table, $return, $select, array $params=null, $strictness=IGNORE_MISSING) {
         if ($select) {
@@ -1366,7 +1392,7 @@ abstract class moodle_database {
      *                        IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended);
      *                        MUST_EXIST means throw exception if no record or multiple records found
      * @return mixed the specified value false if not found
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_field_sql($sql, array $params=null, $strictness=IGNORE_MISSING) {
         if (!$record = $this->get_record_sql($sql, $params, $strictness)) {
@@ -1385,7 +1411,7 @@ abstract class moodle_database {
      * @param string $select A fragment of SQL to be used in a where clause in the SQL call.
      * @param array $params array of sql parameters
      * @return array of values
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public function get_fieldset_select($table, $return, $select, array $params=null) {
         if ($select) {
@@ -1400,7 +1426,7 @@ abstract class moodle_database {
      * @param string $sql The SQL query
      * @param array $params array of sql parameters
      * @return array of values
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public abstract function get_fieldset_sql($sql, array $params=null);
 
@@ -1408,11 +1434,11 @@ abstract class moodle_database {
      * Insert new record into database, as fast as possible, no safety checks, lobs not supported.
      * @param string $table name
      * @param mixed $params data record as object or array
-     * @param bool $returnit return it of inserted record
+     * @param bool $returnid Returns id of inserted record.
      * @param bool $bulk true means repeated inserts expected
      * @param bool $customsequence true if 'id' included in $params, disables $returnid
      * @return bool|int true or new id
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public abstract function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false);
 
@@ -1426,7 +1452,7 @@ abstract class moodle_database {
      * @param object $data A data object with values for one or more fields in the record
      * @param bool $returnid Should the id of the newly created record entry be returned? If this option is not requested then true/false is returned.
      * @return bool|int true or new id
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public abstract function insert_record($table, $dataobject, $returnid=true, $bulk=false);
 
@@ -1437,7 +1463,7 @@ abstract class moodle_database {
      * @param string $table name of database table to be inserted into
      * @param object $dataobject A data object with values for one or more fields in the record
      * @return bool true
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public abstract function import_record($table, $dataobject);
 
@@ -1445,9 +1471,9 @@ abstract class moodle_database {
      * Update record in database, as fast as possible, no safety checks, lobs not supported.
      * @param string $table name
      * @param mixed $params data record as object or array
-     * @param bool true means repeated updates expected
+     * @param bool $bulk True means repeated updates expected.
      * @return bool true
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public abstract function update_record_raw($table, $params, $bulk=false);
 
@@ -1460,9 +1486,9 @@ abstract class moodle_database {
      *
      * @param string $table The database table to be checked against.
      * @param object $dataobject An object with contents equal to fieldname=>fieldvalue. Must have an entry for 'id' to map to the table specified.
-     * @param bool true means repeated updates expected
+     * @param bool $bulk True means repeated updates expected.
      * @return bool true
-     * @throws dml_exception if error
+     * @throws dml_exception A DML specific exception is thrown for any errors.
      */
     public a