Assign feedback plugins - Revision history

Devdocsbot: Protected "Assign feedback plugins": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-10T16:31:54Z

Protected "Assign feedback plugins": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 16:31, 10 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-10T16:29:58Z

Update migration status and path

← Older revision		Revision as of 16:29, 10 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/plugintypes/assign/feedback}}
	== Introduction ==		== Introduction ==
	This page gives an overview of assignment feedback plugins.		This page gives an overview of assignment feedback plugins.

Leonstr: /* locallib.php */ Correction to function name

2021-09-24T16:20:07Z

locallib.php: Correction to function name

← Older revision		Revision as of 16:20, 24 September 2021
Line 262:		Line 262:
	</pre>		</pre>

	The ~~get_form_elements~~ function is called when building the feedback form. It functions identically to the get_settings function except that the grade object is available (if there is a grade) to associate the settings with a single grade attempt. This example also shows how to use a filemanager within a feedback plugin. The function must return true if it has modified the form otherwise the assignment will not include a header for this plugin. Notice there is an older version of this function "get_form_elements" which does not accept a userid as a parameter - this version is less useful - not recommended.		The "get_form_elements_for_user" function is called when building the feedback form. It functions identically to the get_settings function except that the grade object is available (if there is a grade) to associate the settings with a single grade attempt. This example also shows how to use a filemanager within a feedback plugin. The function must return true if it has modified the form otherwise the assignment will not include a header for this plugin. Notice there is an older version of this function "get_form_elements" which does not accept a userid as a parameter - this version is less useful - not recommended.

	<pre>		<pre>

Maherne: /* Add calendar events */

2016-05-24T08:49:20Z

Add calendar events

← Older revision		Revision as of 08:49, 24 May 2016
Line 543:		Line 543:

	=== Add calendar events ===		=== Add calendar events ===

			{{Moodle 3.1}}

	From Moodle 3.1 onwards, feedback plugins can add events to the Moodle calendar without side effects. These will be hidden and deleted in line with the assignment module. For example:		From Moodle 3.1 onwards, feedback plugins can add events to the Moodle calendar without side effects. These will be hidden and deleted in line with the assignment module. For example:

Maherne: Document adding of calendar events.

2016-05-23T08:42:55Z

Document adding of calendar events.

← Older revision		Revision as of 08:42, 23 May 2016
Line 539:		Line 539:

	These two callbacks allow adding entries to the batch grading operations list (where you select multiple users in the table and choose e.g. "Lock submissions" for every user). The action is passed to "grading_batch_operation" so that multiple entries can be supported by a plugin.		These two callbacks allow adding entries to the batch grading operations list (where you select multiple users in the table and choose e.g. "Lock submissions" for every user). The action is passed to "grading_batch_operation" so that multiple entries can be supported by a plugin.

			== Other features ==

			=== Add calendar events ===

			From Moodle 3.1 onwards, feedback plugins can add events to the Moodle calendar without side effects. These will be hidden and deleted in line with the assignment module. For example:

			<pre>
			// Add release date to calendar
			$calendarevent = new stdClass();
			$calendarevent->name = get_string('calendareventname', 'assignsubmission_something');
			$calendarevent->description = get_string('calendareventdesc', 'assignsubmission_something');
			$calendarevent->courseid = $courseid;
			$calendarevent->groupid = 0;
			$calendarevent->userid = $userid;
			$calendarevent->modulename = 'assign';
			$calendarevent->instance = $instanceid;
			$calendarevent->eventtype = 'something_release'; // For activity module's events, this can be used to set the alternative text of the event icon. Set it to 'pluginname' unless you have a better string.
			$calendarevent->timestart = $releasedate;
			$calendarevent->visible = true;
			$calendarevent->timeduration = 0;

			calendar_event::create($calendarevent);
			</pre>

Abgreeve: /* locallib.php */ is_feedback_modified added.

2016-04-18T06:55:16Z

locallib.php: is_feedback_modified added.

← Older revision		Revision as of 06:55, 18 April 2016
Line 263:		Line 263:

	The get_form_elements function is called when building the feedback form. It functions identically to the get_settings function except that the grade object is available (if there is a grade) to associate the settings with a single grade attempt. This example also shows how to use a filemanager within a feedback plugin. The function must return true if it has modified the form otherwise the assignment will not include a header for this plugin. Notice there is an older version of this function "get_form_elements" which does not accept a userid as a parameter - this version is less useful - not recommended.		The get_form_elements function is called when building the feedback form. It functions identically to the get_settings function except that the grade object is available (if there is a grade) to associate the settings with a single grade attempt. This example also shows how to use a filemanager within a feedback plugin. The function must return true if it has modified the form otherwise the assignment will not include a header for this plugin. Notice there is an older version of this function "get_form_elements" which does not accept a userid as a parameter - this version is less useful - not recommended.

			<pre>
			public function is_feedback_modified(stdClass $grade, stdClass $data) {
			$commenttext = '';
			if ($grade) {
			$feedbackcomments = $this->get_feedback_comments($grade->id);
			if ($feedbackcomments) {
			$commenttext = $feedbackcomments->commenttext;
			}
			}

			if ($commenttext == $data->assignfeedbackcomments_editor['text']) {
			return false;
			} else {
			return true;
			}
			}
			</pre>

			The is_feedback_modified function is called before feedback is saved. If feedback has not been modified then the save() method is not called. This function takes the grade object and submitted data from the grading form. In this example we are comparing the existing text comments made with the new ones. This function must return a boolean; True if the feedback has been modified; False if there has been no modification made. If this method is not overwritten then it will default to returning True.

	<pre>		<pre>

Maherne: Added required language strings

2015-12-09T11:58:00Z

Added required language strings

← Older revision		Revision as of 11:58, 9 December 2015
Line 51:		Line 51:
	=== lang/en/assignfeedback_pluginname.php ===		=== lang/en/assignfeedback_pluginname.php ===

	The language file for this plugin must have the same name as the component name (e.g. "assignfeedback_file.php"). It should at least define ~~a string~~ for "pluginname". For example:		The language file for this plugin must have the same name as the component name (e.g. "assignfeedback_file.php"). It should at least define strings for "pluginname", "enabled" and "enabled_help". For example:

	<pre>		<pre>
	$string['pluginname'] = 'Awesome feedback';		$string['pluginname'] = 'Awesome feedback';
			$string['enabled'] = 'Awesome feedback';
			$string['enabled_help'] = 'If enabled, the teacher will be able to provide awesome feedback ';
	</pre>		</pre>

Maherne: Fixed extended class name

2015-12-09T11:52:55Z

Fixed extended class name

← Older revision		Revision as of 11:52, 9 December 2015
Line 204:		Line 204:
	<pre>		<pre>

	class assign_feedback_file extends ~~assign_submission_plugin~~ {		class assign_feedback_file extends assign_feedback_plugin {

	</pre>		</pre>

Maherne at 11:51, 9 December 2015

2015-12-09T11:51:15Z

← Older revision		Revision as of 11:51, 9 December 2015
Line 51:		Line 51:
	=== lang/en/assignfeedback_pluginname.php ===		=== lang/en/assignfeedback_pluginname.php ===

	The language file for this plugin must have the same name as the component name (e.g. "~~feedback_file~~.php"). It should at least define a string for "pluginname". For example:		The language file for this plugin must have the same name as the component name (e.g. "assignfeedback_file.php"). It should at least define a string for "pluginname". For example:

	<pre>		<pre>

Maherne: Fixed language file name

2015-12-09T11:50:48Z

Fixed language file name

← Older revision		Revision as of 11:50, 9 December 2015
Line 49:		Line 49:
	</pre>		</pre>

	=== lang/en/~~feedback_pluginname~~.php ===		=== lang/en/assignfeedback_pluginname.php ===

	The language file for this plugin must have the same name as the component name (e.g. "feedback_file.php"). It should at least define a string for "pluginname". For example:		The language file for this plugin must have the same name as the component name (e.g. "feedback_file.php"). It should at least define a string for "pluginname". For example: