Merge branch 'MDL-52489_master' of git://
[moodle.git] / mod / assign / upgrade.txt
1 This files describes API changes in the assign code.
3 === 3.1 ===
4 * The feedback plugins now need to implement the is_feedback_modified() method. The default is to return true
5   for backwards compatibiltiy.
6 * When downloading all submissions as a zip each students' files are in a separate folder, are no longer renamed
7   and the folder structure is kept intact.
9 === 3.0 ===
10 * assign_submission_status renderable now requires $usergroups in its constructor
12 === 2.9 ===
13 * External parameter now returns PARAM_RAW instead of PARAM_TEXT for webservices using feedback comments.
14 * External function mod_assign_external::get_assignments now returns additional optional fields:
15    - intro: Assignment intro.
16    - introformat: Intro format.
17    - introattachments: Intro attachments files.
19 === 2.8 ===
20 * Some DB changes were made to simplify the SQL required to query the latest attempt.
21   - The assign_submission table now has a column "latest" which is set to 1 for the latest submission attempt.
22   - There will always be a submission row if there is a grade (so the latest grade can be found by joining with the submission)
23   - There is a new submission status "new" for a submission that has never been attempted by a student (but the record exists purely
24     to mark the latest attempt number as 0). The function get_user_submission will create a record with the status set to "new"
25     by default (the previous default was "draft").
27 === 2.7 ===
29 * Added setting sendstudentnotifications to assign DB table with admin defaults. This sets the default value for the
30   "Notify students" option on the grading forms. This setting can be retrieved via webservices.
32 * Web service function mod_assign_save_grade has an additional optional parameter $advancedgradingdata which allows
33   advanced grading data to be used.
34 * A new web service function mod_assign_save_grades has been added which allows multiple grades to be processed.
35 * The event submission_updated() [mod/assign/classes/event/submission_updated.php] has been altered to now be an abstract class
36   for submission events in the submission plug-ins.
38 === 2.6.1 ===
40 * format_text() is no longer used for formating assignment content to be used in events (assign_submission_onlinetext::save()) or
41   the word count (assign_submission_onlinetext::format_for_log()) in mod/assign/submission/onlinetext/locallib.php. format_text()
42   should only be used when displaying information to the screen. It was being used incorrectly before in these areas. Plugins using
43   the event assessable_uploaded() should use file_rewrite_pluginfile_urls() to translate the text back to the desired output.
45 === 2.6 ===
46 * To see submission/grades of inactive users, user should have moodle/course:viewsuspendedusers capability.
47 * count_* functions will return only active participants.
48 * assign_submission_plugin->lock and unlock methods have an additional parameter for user flags. A user will not
49   always have a submission record when the submission is locked/unlocked.
50 * Submission and feedback plugins can now participate in webservices. The plugin must implement get_external_parameters()
51   to describe the parameters it is expecting from the mod_assign_save_grade or mod_assign_save_submission functions. The
52   plugin will then handle the webservice via it's normal save() method with the extra data supplied in the $data argument.
54 === 2.5 ===
56 * New feature - Attempt History
58     This adds settings so that a student can have build up a history of separate submission attempts and grades for the same
59     assignment.
61     Extra settings on the assign table are:
62     attemptreopenmethod - The way attempts can be reopened. One of:
63                             ASSIGN_ATTEMPT_REOPEN_METHOD_NONE - Attempts cannot be reopened (default)
64                             ASSIGN_ATTEMPT_REOPEN_METHOD_UNTIL_PASS - Attempts are reopened on grading until the gradebook
65                                                                       indicates this student has passed.
66                             ASSIGN_ATTEMPT_REOPEN_METHOD_MANUAL - Attempts are reopened on manually by the grader.
67     maxattempts - The maximum allowed number of attempts per student for this assign instance.
69     Extra settings on the submission and grade records:
70     attemptnumber - Starting from 0 until the latest attempt.
72     New table assign_user_flags holds user specific flags that were stored in the assign_grade table.  (contains assignment,
73     userid, extensionduedate, mailed and locked)
75     assign changes:
76         "get_user_grade" function has an extra optional parameter to retrieve a specific attempt number.
77         "get_user_submission" function has an extra optional parameter to retrieve a specific attempt number.
78         "get_group_submission" function has an extra optional parameter to retrieve a specific attempt number.
79         new "get_user_flags" function can retrieve the user flags for a specific user (extensionduedate, mailed and locked).
80         new "update_user_flags" function can update the user flags for a specific user (extensionduedate, mailed and locked).
82     assign_submission_plugin changes:
83         "precheck_submission" function now takes a submission record so you can determine which submission is being checked.
84         "submit_for_grading" function now takes a submission record so you can determine which submission is being submitted.
85         new function "copy_submission" can be implemented to copy submission data from one submission to a new one.
87     New renderable object "assign_attempt_history" for rendering the list of previous submissions.
88     New renderable object "assign_gradingmessage" for rendering a generic grading message.
90     assign_grading_table changes:
91         get_group_and_submission is now protected and should not be called from outside this class.
94 === Earlier changes ===
96 * Were not documented in this way. Sorry.