f49b2b9b514f59d5fc302ba9c2beada8f1167ee8
[moodle.git] / mod / assign / upgrade.txt
1 This files describes API changes in the assign code.
3 === 3.3 ===
4 * Fixed calendar event types for overridden due dates from 'close' to 'due'.
6 === 3.2 ===
7 * External function mod_assign_external::get_assignments now returns additional optional fields:
8    - preventsubmissionnotingroup: Prevent submission not in group.
9    - submissionstatement and submissionstatementformat: When there is a submission statement defined.
10 * Proper checking for empty submissions
11 * Submission modification time checking - this will help students working in groups not clobber each others'
12   submissions
13 * External functions that were returning file information now return the following file fields:
14   filename, filepath, mimetype, filesize, timemodified and fileurl.
15   Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
16   Please, note that previously the filename was part of the filepath field, now they are separated.
17 * Submission and feedback plugins can now specify file areas related to their configuration data,
18   which will then be included in backup and restore; see assign_plugin::get_config_file_areas().
19 * Submission and feedback plugins must now return the specific list of configs available for external functions,
20   this can be done implementing the new assign plugin method get_config_for_external()
21 * Webservice function mod_assign_get_submissions returns a new field 'gradingstatus' from each submission.
23 === 3.1 ===
24 * The feedback plugins now need to implement the is_feedback_modified() method. The default is to return true
25   for backwards compatibiltiy.
26 * When downloading all submissions as a zip each students' files are in a separate folder, are no longer renamed
27   and the folder structure is kept intact.
29 === 3.0 ===
30 * assign_submission_status renderable now requires $usergroups in its constructor
31 * External function mod_assign_external::get_assignments now have a new optional parameter: includenotenrolledcourses.
32   Its default value is false, setting it to true will return assignments for courses a user can see even if it's not enroled.
34 === 2.9 ===
35 * External parameter now returns PARAM_RAW instead of PARAM_TEXT for webservices using feedback comments.
36 * External function mod_assign_external::get_assignments now returns additional optional fields:
37    - intro: Assignment intro.
38    - introformat: Intro format.
39    - introattachments: Intro attachments files.
41 === 2.8 ===
42 * Some DB changes were made to simplify the SQL required to query the latest attempt.
43   - The assign_submission table now has a column "latest" which is set to 1 for the latest submission attempt.
44   - There will always be a submission row if there is a grade (so the latest grade can be found by joining with the submission)
45   - There is a new submission status "new" for a submission that has never been attempted by a student (but the record exists purely
46     to mark the latest attempt number as 0). The function get_user_submission will create a record with the status set to "new"
47     by default (the previous default was "draft").
49 === 2.7 ===
51 * Added setting sendstudentnotifications to assign DB table with admin defaults. This sets the default value for the
52   "Notify students" option on the grading forms. This setting can be retrieved via webservices.
54 * Web service function mod_assign_save_grade has an additional optional parameter $advancedgradingdata which allows
55   advanced grading data to be used.
56 * A new web service function mod_assign_save_grades has been added which allows multiple grades to be processed.
57 * The event submission_updated() [mod/assign/classes/event/submission_updated.php] has been altered to now be an abstract class
58   for submission events in the submission plug-ins.
60 === 2.6.1 ===
62 * format_text() is no longer used for formating assignment content to be used in events (assign_submission_onlinetext::save()) or
63   the word count (assign_submission_onlinetext::format_for_log()) in mod/assign/submission/onlinetext/locallib.php. format_text()
64   should only be used when displaying information to the screen. It was being used incorrectly before in these areas. Plugins using
65   the event assessable_uploaded() should use file_rewrite_pluginfile_urls() to translate the text back to the desired output.
67 === 2.6 ===
68 * To see submission/grades of inactive users, user should have moodle/course:viewsuspendedusers capability.
69 * count_* functions will return only active participants.
70 * assign_submission_plugin->lock and unlock methods have an additional parameter for user flags. A user will not
71   always have a submission record when the submission is locked/unlocked.
72 * Submission and feedback plugins can now participate in webservices. The plugin must implement get_external_parameters()
73   to describe the parameters it is expecting from the mod_assign_save_grade or mod_assign_save_submission functions. The
74   plugin will then handle the webservice via it's normal save() method with the extra data supplied in the $data argument.
76 === 2.5 ===
78 * New feature - Attempt History
80     This adds settings so that a student can have build up a history of separate submission attempts and grades for the same
81     assignment.
83     Extra settings on the assign table are:
84     attemptreopenmethod - The way attempts can be reopened. One of:
85                             ASSIGN_ATTEMPT_REOPEN_METHOD_NONE - Attempts cannot be reopened (default)
86                             ASSIGN_ATTEMPT_REOPEN_METHOD_UNTIL_PASS - Attempts are reopened on grading until the gradebook
87                                                                       indicates this student has passed.
88                             ASSIGN_ATTEMPT_REOPEN_METHOD_MANUAL - Attempts are reopened on manually by the grader.
89     maxattempts - The maximum allowed number of attempts per student for this assign instance.
91     Extra settings on the submission and grade records:
92     attemptnumber - Starting from 0 until the latest attempt.
94     New table assign_user_flags holds user specific flags that were stored in the assign_grade table.  (contains assignment,
95     userid, extensionduedate, mailed and locked)
97     assign changes:
98         "get_user_grade" function has an extra optional parameter to retrieve a specific attempt number.
99         "get_user_submission" function has an extra optional parameter to retrieve a specific attempt number.
100         "get_group_submission" function has an extra optional parameter to retrieve a specific attempt number.
101         new "get_user_flags" function can retrieve the user flags for a specific user (extensionduedate, mailed and locked).
102         new "update_user_flags" function can update the user flags for a specific user (extensionduedate, mailed and locked).
104     assign_submission_plugin changes:
105         "precheck_submission" function now takes a submission record so you can determine which submission is being checked.
106         "submit_for_grading" function now takes a submission record so you can determine which submission is being submitted.
107         new function "copy_submission" can be implemented to copy submission data from one submission to a new one.
109     New renderable object "assign_attempt_history" for rendering the list of previous submissions.
110     New renderable object "assign_gradingmessage" for rendering a generic grading message.
112     assign_grading_table changes:
113         get_group_and_submission is now protected and should not be called from outside this class.
116 === Earlier changes ===
118 * Were not documented in this way. Sorry.