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