52685333bbe27fde8e38b69e76ec2b06f377428f
[moodle.git] / mod / assign / upgrade.txt
1 This files describes API changes in the assign code.
2 === 3.8 ===
3 * Webservice function mod_assign_get_submission_status, return value 'warnofungroupedusers', changed from PARAM_BOOL to PARAM_ALPHA. See the description for possible values.
4 * The following functions have been finally deprecated and can not be used anymore:
5     * assign_scale_used()
7 === 3.7 ===
8 * Submissions plugins should implement the "remove" function to remove data when "Remove submission" is used.
10 === 3.6 ===
11 * The mod_assign_base_testcase unit test base class has been deprecated.
12   It encouraged poor unit test design and led to significant performance issues with unit tests. See MDL-55609 for
13   further information.
14 * The function can_grade() now has optional $user parameter.
15 * Feedback plugins can now specify whether or not they want to attach files to the
16   feedback that is stored in the gradebook via the new method files_for_gradebook().
17   An example of what this method would return is -
18   [
19       'contextid' => $modulecontext->id,
20       'component' => ASSIGNFEEDBACK_XYZ_COMPONENT,
21       'filearea' => ASSIGNFEEDBACK_XYZ_FILEAREA,
22       'itemid' => $grade->id
23   ]
25 === 3.5 ===
26 * Functions assign:get_assign_grading_summary_renderable, assign:can_view_submission, assign:count_submissions_with_status,
27   assign:count_submissions_need_grading and mod_assign_external::get_submission_status now admit an additional group parameter.
28   This parameter can be used to force those functions to retrieve data only for the given group.
30 === 3.4 ===
31 * assign::add_attempt requires that set_most_recent_team_submission() be called if attempting to use this function with a team
32   submission.
34 === 3.3.2 ===
35 * assign_refresh_events() Now takes two additional parameters to refine the update to a specific instance. This function
36   now optionally takes the module instance object or ID, and the course module object or ID. Please try to send the full
37   objects instead of the ids to save DB calls.
39 === 3.3 ===
40 * All pluginfile file serving functions now pass through the options to send_stored_file() (all assignment plugins should do
41   the same).
42 * Fixed calendar event types for overridden due dates from 'close' to 'due'.
43 * Removed calendar event type of 'open', since mod_assign only has the 'due' event type. No point in creating an override event
44 for an event type that does not exist.
46 === 3.2 ===
47 * External function mod_assign_external::get_assignments now returns additional optional fields:
48    - preventsubmissionnotingroup: Prevent submission not in group.
49    - submissionstatement and submissionstatementformat: When there is a submission statement defined.
50 * Proper checking for empty submissions
51 * Submission modification time checking - this will help students working in groups not clobber each others'
52   submissions
53 * External functions that were returning file information now return the following file fields:
54   filename, filepath, mimetype, filesize, timemodified and fileurl.
55   Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
56   Please, note that previously the filename was part of the filepath field, now they are separated.
57 * Submission and feedback plugins can now specify file areas related to their configuration data,
58   which will then be included in backup and restore; see assign_plugin::get_config_file_areas().
59 * Submission and feedback plugins must now return the specific list of configs available for external functions,
60   this can be done implementing the new assign plugin method get_config_for_external()
61 * Webservice function mod_assign_get_submissions returns a new field 'gradingstatus' from each submission.
63 === 3.1 ===
64 * The feedback plugins now need to implement the is_feedback_modified() method. The default is to return true
65   for backwards compatibiltiy.
66 * When downloading all submissions as a zip each students' files are in a separate folder, are no longer renamed
67   and the folder structure is kept intact.
69 === 3.0 ===
70 * assign_submission_status renderable now requires $usergroups in its constructor
71 * External function mod_assign_external::get_assignments now have a new optional parameter: includenotenrolledcourses.
72   Its default value is false, setting it to true will return assignments for courses a user can see even if it's not enroled.
74 === 2.9 ===
75 * External parameter now returns PARAM_RAW instead of PARAM_TEXT for webservices using feedback comments.
76 * External function mod_assign_external::get_assignments now returns additional optional fields:
77    - intro: Assignment intro.
78    - introformat: Intro format.
79    - introattachments: Intro attachments files.
81 === 2.8 ===
82 * Some DB changes were made to simplify the SQL required to query the latest attempt.
83   - The assign_submission table now has a column "latest" which is set to 1 for the latest submission attempt.
84   - There will always be a submission row if there is a grade (so the latest grade can be found by joining with the submission)
85   - There is a new submission status "new" for a submission that has never been attempted by a student (but the record exists purely
86     to mark the latest attempt number as 0). The function get_user_submission will create a record with the status set to "new"
87     by default (the previous default was "draft").
89 === 2.7 ===
91 * Added setting sendstudentnotifications to assign DB table with admin defaults. This sets the default value for the
92   "Notify students" option on the grading forms. This setting can be retrieved via webservices.
94 * Web service function mod_assign_save_grade has an additional optional parameter $advancedgradingdata which allows
95   advanced grading data to be used.
96 * A new web service function mod_assign_save_grades has been added which allows multiple grades to be processed.
97 * The event submission_updated() [mod/assign/classes/event/submission_updated.php] has been altered to now be an abstract class
98   for submission events in the submission plug-ins.
100 === 2.6.1 ===
102 * format_text() is no longer used for formating assignment content to be used in events (assign_submission_onlinetext::save()) or
103   the word count (assign_submission_onlinetext::format_for_log()) in mod/assign/submission/onlinetext/locallib.php. format_text()
104   should only be used when displaying information to the screen. It was being used incorrectly before in these areas. Plugins using
105   the event assessable_uploaded() should use file_rewrite_pluginfile_urls() to translate the text back to the desired output.
107 === 2.6 ===
108 * To see submission/grades of inactive users, user should have moodle/course:viewsuspendedusers capability.
109 * count_* functions will return only active participants.
110 * assign_submission_plugin->lock and unlock methods have an additional parameter for user flags. A user will not
111   always have a submission record when the submission is locked/unlocked.
112 * Submission and feedback plugins can now participate in webservices. The plugin must implement get_external_parameters()
113   to describe the parameters it is expecting from the mod_assign_save_grade or mod_assign_save_submission functions. The
114   plugin will then handle the webservice via it's normal save() method with the extra data supplied in the $data argument.
116 === 2.5 ===
118 * New feature - Attempt History
120     This adds settings so that a student can have build up a history of separate submission attempts and grades for the same
121     assignment.
123     Extra settings on the assign table are:
124     attemptreopenmethod - The way attempts can be reopened. One of:
125                             ASSIGN_ATTEMPT_REOPEN_METHOD_NONE - Attempts cannot be reopened (default)
126                             ASSIGN_ATTEMPT_REOPEN_METHOD_UNTIL_PASS - Attempts are reopened on grading until the gradebook
127                                                                       indicates this student has passed.
128                             ASSIGN_ATTEMPT_REOPEN_METHOD_MANUAL - Attempts are reopened on manually by the grader.
129     maxattempts - The maximum allowed number of attempts per student for this assign instance.
131     Extra settings on the submission and grade records:
132     attemptnumber - Starting from 0 until the latest attempt.
134     New table assign_user_flags holds user specific flags that were stored in the assign_grade table.  (contains assignment,
135     userid, extensionduedate, mailed and locked)
137     assign changes:
138         "get_user_grade" function has an extra optional parameter to retrieve a specific attempt number.
139         "get_user_submission" function has an extra optional parameter to retrieve a specific attempt number.
140         "get_group_submission" function has an extra optional parameter to retrieve a specific attempt number.
141         new "get_user_flags" function can retrieve the user flags for a specific user (extensionduedate, mailed and locked).
142         new "update_user_flags" function can update the user flags for a specific user (extensionduedate, mailed and locked).
144     assign_submission_plugin changes:
145         "precheck_submission" function now takes a submission record so you can determine which submission is being checked.
146         "submit_for_grading" function now takes a submission record so you can determine which submission is being submitted.
147         new function "copy_submission" can be implemented to copy submission data from one submission to a new one.
149     New renderable object "assign_attempt_history" for rendering the list of previous submissions.
150     New renderable object "assign_gradingmessage" for rendering a generic grading message.
152     assign_grading_table changes:
153         get_group_and_submission is now protected and should not be called from outside this class.
156 === Earlier changes ===
158 * Were not documented in this way. Sorry.