Permalink
Browse files

MDL-30999 grade: updated Grade API phpdocs

  • Loading branch information...
1 parent 5fc420e commit a153c9f2fe1fe77a1a0fb86408a5ff2e97513be6 @andyjdavis andyjdavis committed Jan 6, 2012
Showing with 1,463 additions and 823 deletions.
  1. +8 −1 grade/edit/letter/edit_form.php
  2. +1 −2 grade/edit/letter/index.php
  3. +8 −1 grade/edit/letter/tabs.php
  4. +8 −1 grade/edit/outcome/course.php
  5. +1 −2 grade/edit/outcome/edit.php
  6. +8 −1 grade/edit/outcome/edit_form.php
  7. +7 −2 grade/edit/outcome/export.php
  8. +8 −1 grade/edit/outcome/import.php
  9. +8 −1 grade/edit/outcome/import_outcomes_form.php
  10. +1 −2 grade/edit/outcome/index.php
  11. +8 −1 grade/edit/outcome/tabs.php
  12. +8 −1 grade/edit/scale/edit.php
  13. +8 −1 grade/edit/scale/edit_form.php
  14. +8 −1 grade/edit/scale/index.php
  15. +8 −1 grade/edit/settings/form.php
  16. +8 −1 grade/edit/settings/index.php
  17. +8 −1 grade/edit/tree/action.php
  18. +8 −1 grade/edit/tree/calculation.php
  19. +8 −1 grade/edit/tree/calculation_form.php
  20. +8 −1 grade/edit/tree/category.php
  21. +8 −1 grade/edit/tree/category_form.php
  22. +8 −1 grade/edit/tree/grade.php
  23. +8 −1 grade/edit/tree/grade_form.php
  24. +2 −3 grade/edit/tree/index.php
  25. +9 −1 grade/edit/tree/item.php
  26. +8 −1 grade/edit/tree/item_form.php
  27. +8 −1 grade/edit/tree/lib.php
  28. +8 −1 grade/edit/tree/outcomeitem.php
  29. +8 −1 grade/edit/tree/outcomeitem_form.php
  30. +1 −2 grade/grading/manage.php
  31. +1 −2 grade/grading/pick.php
  32. +6 −3 grade/index.php
  33. +6 −7 grade/lib.php
  34. +26 −16 grade/querylib.php
  35. +7 −1 grade/report/grader/ajax_callbacks.php
  36. +8 −1 grade/report/grader/db/access.php
  37. +8 −1 grade/report/grader/index.php
  38. +1 −1 grade/report/grader/lang/en/gradereport_grader.php
  39. +6 −4 grade/report/grader/lib.php
  40. +8 −1 grade/report/grader/preferences.php
  41. +2 −5 grade/report/grader/preferences_form.php
  42. +8 −1 grade/report/grader/quickedit_item.php
  43. +8 −1 grade/report/grader/settings.php
  44. +8 −1 grade/report/grader/tabs.php
  45. +2 −3 grade/report/grader/version.php
  46. +8 −1 grade/report/index.php
  47. +6 −5 grade/report/lib.php
  48. +8 −1 grade/report/outcomes/db/access.php
  49. +8 −1 grade/report/outcomes/index.php
  50. +1 −1 grade/report/outcomes/lang/en/gradereport_outcomes.php
  51. +2 −3 grade/report/outcomes/version.php
  52. +8 −1 grade/report/overview/db/access.php
  53. +8 −1 grade/report/overview/index.php
  54. +1 −2 grade/report/overview/lang/en/gradereport_overview.php
  55. +6 −4 grade/report/overview/lib.php
  56. +3 −4 grade/report/overview/renderer.php
  57. +7 −2 grade/report/overview/settings.php
  58. +2 −3 grade/report/overview/version.php
  59. +8 −1 grade/report/user/db/access.php
  60. +8 −1 grade/report/user/index.php
  61. +1 −2 grade/report/user/lang/en/gradereport_user.php
  62. +6 −4 grade/report/user/lib.php
  63. +2 −3 grade/report/user/renderer.php
  64. +7 −2 grade/report/user/settings.php
  65. +2 −3 grade/report/user/version.php
  66. +188 −12 lib/grade/constants.php
  67. +120 −122 lib/grade/grade_category.php
  68. +80 −55 lib/grade/grade_grade.php
  69. +192 −121 lib/grade/grade_item.php
  70. +75 −34 lib/grade/grade_object.php
  71. +43 −21 lib/grade/grade_outcome.php
  72. +35 −14 lib/grade/grade_scale.php
  73. +18 −27 lib/grade/simpletest/testgradecategory.php
  74. +18 −27 lib/grade/simpletest/testgradegrades.php
  75. +18 −27 lib/grade/simpletest/testgradeitem.php
  76. +18 −27 lib/grade/simpletest/testgradeoutcome.php
  77. +18 −27 lib/grade/simpletest/testgradescale.php
  78. +126 −122 lib/gradelib.php
  79. +27 −1 mod/assignment/grade.php
  80. +18 −8 mod/assignment/lib.php
  81. +5 −6 mod/data/lib.php
  82. +7 −8 mod/forum/lib.php
  83. +12 −14 mod/glossary/lib.php
  84. +5 −6 mod/lesson/grade.php
  85. +3 −4 mod/lesson/lib.php
  86. +2 −0 mod/lti/lib.php
  87. +4 −4 mod/quiz/grade.php
  88. +5 −1 mod/quiz/lib.php
  89. +9 −0 mod/scorm/grade.php
  90. +3 −5 mod/scorm/lib.php
  91. +1 −0 mod/workshop/lib.php
@@ -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
@@ -15,6 +14,14 @@
// 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
}
@@ -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
*/
@@ -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
@@ -15,6 +14,14 @@
// 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',
@@ -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
@@ -15,6 +14,14 @@
// 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';
@@ -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
*/
@@ -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
@@ -15,6 +14,14 @@
// 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
}
@@ -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
@@ -15,7 +14,13 @@
// 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';
@@ -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
@@ -15,6 +14,14 @@
// 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');
@@ -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
@@ -15,6 +14,14 @@
// 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
}
@@ -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
*/
@@ -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
@@ -15,6 +14,14 @@
// 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);
@@ -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
@@ -15,6 +14,14 @@
// 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';
@@ -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
@@ -15,6 +14,14 @@
// 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
}
@@ -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
@@ -15,6 +14,14 @@
// 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';
@@ -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
@@ -15,6 +14,14 @@
// 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
}
@@ -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
@@ -15,6 +14,14 @@
// 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';
@@ -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
@@ -15,6 +14,14 @@
// 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';
@@ -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
@@ -15,6 +14,14 @@
// 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';
@@ -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
@@ -15,6 +14,14 @@
// 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
}
Oops, something went wrong.

0 comments on commit a153c9f

Please sign in to comment.