Library class for comment submission plugin extending submission plugin base class. More...

Inheritance diagram for assign_submission_comments:

Public Member Functions
	add_attempt (stdClass $oldsubmission, stdClass $newsubmission)
	Carry out any extra processing required when a student is given a new attempt (i.e.

	allow_image_conversion ()
	Determine if the plugin allows image file conversion.

	allow_submissions ()
	The submission comments plugin has no submission component so should not be counted when determining whether to show the edit submission link.

	can_upgrade ($type, $version)
	Return true if this plugin can upgrade an old Moodle 2.2 assignment of this type and version.

	copy_submission (stdClass $oldsubmission, stdClass $submission)
	Copy the plugin specific submission data to a new submission record.

	data_preprocessing (&$defaultvalues)
	Allows the plugin to update the defaultvalues passed in to the settings form (needed to set up draft areas for editor and filemanager elements)

	delete_instance ()
	The assignment has been deleted - remove the plugin specific data.

	disable ()
	Set this plugin to disabled.

	enable ()
	Set this plugin to enabled.

	get_config ($setting=null)
	Get a configuration value for this plugin.

	get_config_file_areas ()
	Get a list of file areas associated with the plugin configuration.

	get_config_for_external ()
	Return the plugin configs for external functions.

	get_editor_fields ()
	Return a list of the fields that can be exported or imported via text.

	get_editor_format ($name, $submissionid)
	Given a field name, should return the format of an editor field that is part of this plugin.

	get_editor_text ($name, $submissionorgradeid)
	Given a field name, should return the text of an editor field that is part of this plugin.

	get_error ()
	What was the last error?

	get_external_parameters ()
	If this plugin can participate in a webservice (save_submission or save_grade), return a list of external_params to be included in the definition of that webservice.

	get_file_areas ()
	Get file areas returns a list of areas this plugin stores files.

	get_file_info ($browser, $filearea, $itemid, $filepath, $filename)
	Default implementation of file_get_info for plugins.

	get_files (stdClass $submissionorgrade, stdClass $user)
	Produce a list of files suitable for export that represent this feedback or submission.

	get_form_elements ($submissionorgrade, MoodleQuickForm $mform, stdClass $data)
	Get any additional fields for the submission/grading form for this assignment.

	get_form_elements_for_user ($submissionorgrade, MoodleQuickForm $mform, stdClass $data, $userid)
	Get any additional fields for the submission/grading form for this assignment.

	get_name ()
	Get the name of the online comment submission plugin.

	get_requires ()
	Get the required moodle version for this plugin.

	get_settings (MoodleQuickForm $mform)
	This function should be overridden to provide an array of elements that can be added to a moodle form for display in the settings page for the assignment.

	get_sort_order ()
	Get the numerical sort order for this plugin.

	get_subtype ()
	return subtype name of the plugin

	get_type ()
	Should return the type of this plugin.

	get_version ()
	Get the installed version of this plugin.

	has_admin_settings ()
	Has this plugin got a custom settings.php file?

	has_user_summary ()
	If this plugin should not include a column in the grading table or a row on the summary page then return false.

	is_configurable ()
	Automatically hide the setting for the submission plugin.

	is_empty (stdClass $submission)
	Always return true because the submission comments are not part of the submission form.

	is_enabled ()
	Automatically enable or disable this plugin based on "$CFG->commentsenabled".

	is_first ()
	Is this the first plugin in the list?

	is_last ()
	Is this the last plugin in the list?

	is_visible ()
	Is this plugin enaled?

	lock ($submission, stdClass $flags)
	Carry out any extra processing required when the work is locked.

	precheck_submission ($submission)
	Check if the submission plugin has all the required data to allow the work to be submitted for grading.

	remove (stdClass $submission)
	Remove any saved data from this submission.

	revert_to_draft (stdClass $submission)
	Carry out any extra processing required when the work reverted to draft.

	save (stdClass $submissionorgrade, stdClass $data)
	Save any custom data for this form submission.

	save_settings (stdClass $formdata)
	The assignment subtype is responsible for saving it's own settings as the database table for the standard type cannot be modified.

	set_config ($name, $value)
	Set a configuration value for this plugin.

	set_editor_format ($name, $format, $submissionorgradeid)
	Given a field name and value should update the format for this field in the plugins submission or grade.

	set_editor_text ($name, $value, $submissionorgradeid)
	Given a field name and value should update the text for this field in the plugins submission or grade.

	settings_validation (array $data, array $files)
	This method is called when the mod_assign_mod_form is submitted.

	submission_is_empty (stdClass $data)
	Determine if a submission is empty.

	submission_summary_for_messages (stdClass $submission)
	Summarise a submission for inclusion in messages.

	submit_for_grading ($submission)
	Carry out any extra processing required when the work is submitted for grading.

	unlock ($submission, stdClass $flags)
	Carry out any extra processing required when the work is unlocked.

	upgrade (context $oldcontext, stdClass $oldassignment, stdClass $oldsubmission, stdClass $submission, & $log)
	Upgrade the submission from the old assignment to the new one.

	upgrade_settings (context $oldcontext, stdClass $oldassignment, & $log)
	Upgrade the settings from the old assignment to the new plugin based one.

	view (stdClass $submissionorgrade)
	Should not output anything - return the result as a string so it can be consumed by webservices.

	view_header ()
	This allows a plugin to render an introductory section which is displayed right below the activity's "intro" section on the main assignment page.

	view_page ($action)
	This allows a plugin to render a page in the context of the assignment.

	view_summary (stdClass $submission, & $showviewlink)
	Display AJAX based comment in the submission status table.

Static Public Member Functions
static	cron ()
	Run cron for this plugin.

Protected Member Functions
	set_error ($msg)
	Save the error message from the last error.

Protected Attributes
assign	$assignment
	$assignment the assignment record that contains the global settings for this assign instance

Detailed Description

Library class for comment submission plugin extending submission plugin base class.

Copyright: 2012 NetSpot

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ add_attempt()

assign_submission_plugin::add_attempt	(	stdClass	$oldsubmission,
		stdClass	$newsubmission )

inherited

Carry out any extra processing required when a student is given a new attempt (i.e.

when the submission is "reopened"

Parameters

stdClass	$oldsubmission	The previous attempt
stdClass	$newsubmission	The new attempt

◆ allow_image_conversion()

assign_submission_plugin::allow_image_conversion ( )

inherited

Determine if the plugin allows image file conversion.

Return values

bool

Reimplemented in assign_submission_file.

◆ allow_submissions()

assign_submission_comments::allow_submissions ( )

The submission comments plugin has no submission component so should not be counted when determining whether to show the edit submission link.

Return values

boolean

Reimplemented from assign_submission_plugin.

◆ can_upgrade()

assign_submission_comments::can_upgrade	(		$type,
			$version )

Return true if this plugin can upgrade an old Moodle 2.2 assignment of this type and version.

Parameters

string	$type	old assignment subtype
int	$version	old assignment version

Return values

bool	True if upgrade is possible

Reimplemented from assign_plugin.

◆ copy_submission()

assign_submission_plugin::copy_submission	(	stdClass	$oldsubmission,
		stdClass	$submission )

inherited

Copy the plugin specific submission data to a new submission record.

Parameters

stdClass	$oldsubmission	- Old submission record
stdClass	$submission	- New submission record

Return values

bool

Reimplemented in assign_submission_file, and assign_submission_onlinetext.

◆ data_preprocessing()

assign_plugin::data_preprocessing ( & $defaultvalues )

inherited

Allows the plugin to update the defaultvalues passed in to the settings form (needed to set up draft areas for editor and filemanager elements)

Parameters

array $defaultvalues

◆ delete_instance()

assign_plugin::delete_instance ( )

inherited

The assignment has been deleted - remove the plugin specific data.

Return values

bool

Reimplemented in assign_feedback_comments, assign_feedback_editpdf, assign_feedback_file, assign_submission_file, and assign_submission_onlinetext.

◆ disable()

assign_plugin::disable ( )

finalinherited

Set this plugin to disabled.

Return values

bool

◆ enable()

assign_plugin::enable ( )

finalinherited

Set this plugin to enabled.

Return values

bool

◆ get_config()

assign_plugin::get_config ( $setting = null )

finalinherited

Get a configuration value for this plugin.

Parameters

mixed $setting The config key (string) or null

Return values

mixed string | false

◆ get_config_file_areas()

assign_plugin::get_config_file_areas ( )

inherited

Get a list of file areas associated with the plugin configuration.

This is used for backup/restore.

Return values

array names of the fileareas, can be an empty array

◆ get_config_for_external()

assign_submission_comments::get_config_for_external ( )

Return the plugin configs for external functions.

Return values

array the list of settings

Since: Moodle 3.2

Reimplemented from assign_plugin.

◆ get_editor_fields()

assign_plugin::get_editor_fields ( )

inherited

Return a list of the fields that can be exported or imported via text.

Return values

array - The list of field names (strings) and descriptions. ($name => $description)

Reimplemented in assign_feedback_comments, and assign_submission_onlinetext.

◆ get_editor_format()

assign_plugin::get_editor_format	(		$name,
			$submissionid )

inherited

Given a field name, should return the format of an editor field that is part of this plugin.

This is used when exporting to portfolio.

Parameters

string	$name	Name of the field.
int	$submissionid	The id of the submission

Return values

int	- The format for the editor field

Reimplemented in assign_submission_onlinetext.

◆ get_editor_text()

assign_plugin::get_editor_text	(		$name,
			$submissionorgradeid )

inherited

Given a field name, should return the text of an editor field that is part of this plugin.

This is used when exporting to portfolio.

Parameters

string	$name	Name of the field.
int	$submissionorgradeid	The id of the submission or grade

Return values

string - The text for the editor field

Reimplemented in assign_feedback_comments, and assign_submission_onlinetext.

◆ get_error()

assign_plugin::get_error ( )

finalinherited

What was the last error?

Return values

string

◆ get_external_parameters()

assign_plugin::get_external_parameters ( )

inherited

If this plugin can participate in a webservice (save_submission or save_grade), return a list of external_params to be included in the definition of that webservice.

Return values

external_description|null

Reimplemented in assign_feedback_comments, assign_feedback_file, assign_submission_file, and assign_submission_onlinetext.

◆ get_file_areas()

assign_plugin::get_file_areas ( )

inherited

Get file areas returns a list of areas this plugin stores files.

Return values

array - An array of fileareas (keys) and descriptions (values)

Reimplemented in assign_feedback_comments, assign_feedback_editpdf, assign_feedback_file, assign_submission_file, and assign_submission_onlinetext.

◆ get_file_info()

assign_plugin::get_file_info	(	$browser,
		$filearea,
		$itemid,
		$filepath,
		$filename )

inherited

Default implementation of file_get_info for plugins.

This is used by the filebrowser to browse a plugins file areas.

This implementation should work for most plugins but can be overridden if required.

Parameters

file_browser	$browser
string	$filearea
int	$itemid
string	$filepath
string	$filename

Return values

file_info_stored

◆ get_files()

assign_plugin::get_files	(	stdClass	$submissionorgrade,
		stdClass	$user )

inherited

Produce a list of files suitable for export that represent this feedback or submission.

Parameters

stdClass	$submissionorgrade	assign_submission or assign_grade For submission plugins this is the submission data, for feedback plugins it is the grade data
stdClass	$user	The user record for the current submission. Needed for url rewriting if this is a group submission.

Return values

array - return an array of files indexed by filename

Reimplemented in assign_submission_file, and assign_submission_onlinetext.

◆ get_form_elements()

assign_plugin::get_form_elements	(		$submissionorgrade,
		MoodleQuickForm	$mform,
		stdClass	$data )

inherited

Get any additional fields for the submission/grading form for this assignment.

This function is retained for backwards compatibility - new plugins should override get_form_elements_for_user().

Parameters

mixed	$submissionorgrade	submission\|grade - For submission plugins this is the submission data, for feedback plugins it is the grade data
MoodleQuickForm	$mform	- This is the form
stdClass	$data	- This is the form data that can be modified for example by a filemanager element

Return values

boolean - true if we added anything to the form

Reimplemented in assign_feedback_offline, assign_submission_file, and assign_submission_onlinetext.

◆ get_form_elements_for_user()

assign_plugin::get_form_elements_for_user	(		$submissionorgrade,
		MoodleQuickForm	$mform,
		stdClass	$data,
			$userid )

inherited

Get any additional fields for the submission/grading form for this assignment.

Parameters

mixed	$submissionorgrade	submission\|grade - For submission plugins this is the submission data, for feedback plugins it is the grade data
MoodleQuickForm	$mform	- This is the form
stdClass	$data	- This is the form data that can be modified for example by a filemanager element
int	$userid	- This is the userid for the current submission. This is passed separately as there may not yet be a submission or grade.

Return values

boolean - true if we added anything to the form

Reimplemented in assign_feedback_comments, assign_feedback_editpdf, and assign_feedback_file.

◆ get_name()

assign_submission_comments::get_name ( )

Get the name of the online comment submission plugin.

Return values

string

Reimplemented from assign_plugin.

◆ get_requires()

assign_plugin::get_requires ( )

finalinherited

Get the required moodle version for this plugin.

Return values

string

◆ get_settings()

assign_plugin::get_settings ( MoodleQuickForm $mform )

inherited

This function should be overridden to provide an array of elements that can be added to a moodle form for display in the settings page for the assignment.

Parameters

MoodleQuickForm $mform The form to add the elements to

Return values

$array

Reimplemented in assign_feedback_comments, assign_submission_file, and assign_submission_onlinetext.

◆ get_sort_order()

assign_plugin::get_sort_order ( )

finalinherited

Get the numerical sort order for this plugin.

Return values

int

◆ get_subtype()

assign_submission_plugin::get_subtype ( )

finalinherited

return subtype name of the plugin

Return values

string

Reimplemented from assign_plugin.

◆ get_type()

assign_plugin::get_type ( )

finalinherited

Should return the type of this plugin.

Return values

string - the type

◆ get_version()

assign_plugin::get_version ( )

finalinherited

Get the installed version of this plugin.

Return values

string

◆ has_admin_settings()

assign_plugin::has_admin_settings ( )

finalinherited

Has this plugin got a custom settings.php file?

Return values

bool

◆ has_user_summary()

assign_plugin::has_user_summary ( )

inherited

If this plugin should not include a column in the grading table or a row on the summary page then return false.

Return values

bool

Reimplemented in assign_feedback_offline.

◆ is_configurable()

assign_submission_comments::is_configurable ( )

Automatically hide the setting for the submission plugin.

Return values

bool

Reimplemented from assign_plugin.

◆ is_empty()

assign_submission_comments::is_empty ( stdClass $submission )

Always return true because the submission comments are not part of the submission form.

Parameters

stdClass $submission

Return values

bool

Reimplemented from assign_plugin.

◆ is_enabled()

assign_submission_comments::is_enabled ( )

Automatically enable or disable this plugin based on "$CFG->commentsenabled".

Return values

bool

Reimplemented from assign_plugin.

◆ is_first()

assign_plugin::is_first ( )

finalinherited

Is this the first plugin in the list?

Return values

bool

◆ is_last()

assign_plugin::is_last ( )

finalinherited

Is this the last plugin in the list?

Return values

bool

◆ is_visible()

assign_plugin::is_visible ( )

finalinherited

Is this plugin enaled?

Return values

bool

◆ lock()

assign_submission_plugin::lock	(		$submission,
		stdClass	$flags )

inherited

Carry out any extra processing required when the work is locked.

Parameters

stdClass \| false	$submission	- assign_submission data if any
stdClass	$flags	- User flags record

Return values

void

◆ precheck_submission()

assign_submission_plugin::precheck_submission ( $submission )

inherited

Check if the submission plugin has all the required data to allow the work to be submitted for grading.

Parameters

stdClass $submission the assign_submission record being submitted.

Return values

bool|string 'true' if OK to proceed with submission, otherwise a a message to display to the user

◆ remove()

assign_submission_plugin::remove ( stdClass $submission )

inherited

Remove any saved data from this submission.

Parameters

stdClass $submission - assign_submission data

Return values

void

Reimplemented in assign_submission_file, and assign_submission_onlinetext.

◆ revert_to_draft()

assign_submission_plugin::revert_to_draft ( stdClass $submission )

inherited

Carry out any extra processing required when the work reverted to draft.

Parameters

stdClass $submission - assign_submission data

Return values

void

◆ save()

assign_plugin::save	(	stdClass	$submissionorgrade,
		stdClass	$data )

inherited

Save any custom data for this form submission.

Parameters

stdClass	$submissionorgrade	- assign_submission or assign_grade. For submission plugins this is the submission data, for feedback plugins it is the grade data
stdClass	$data	- the data submitted from the form

Return values

bool	- on error the subtype should call set_error and return false.

Reimplemented in assign_feedback_comments, assign_feedback_editpdf, assign_feedback_file, assign_submission_file, and assign_submission_onlinetext.

◆ save_settings()

assign_plugin::save_settings ( stdClass $formdata )

inherited

The assignment subtype is responsible for saving it's own settings as the database table for the standard type cannot be modified.

Parameters

stdClass $formdata - the data submitted from the form

Return values

bool	- on error the subtype should call set_error and return false.

Reimplemented in assign_feedback_comments, assign_submission_file, and assign_submission_onlinetext.

◆ set_config()

assign_plugin::set_config	(		$name,
			$value )

finalinherited

Set a configuration value for this plugin.

Parameters

string	$name	The config key
string	$value	The config value

Return values

bool

◆ set_editor_format()

assign_plugin::set_editor_format	(	$name,
		$format,
		$submissionorgradeid )

inherited

Given a field name and value should update the format for this field in the plugins submission or grade.

Parameters

string	$name	Name of the field.
int	$format	Updated format.
int	$submissionorgradeid	The id of the submission or grade.

Return values

bool	- true if the value was updated

◆ set_editor_text()

assign_plugin::set_editor_text	(	$name,
		$value,
		$submissionorgradeid )

inherited

Given a field name and value should update the text for this field in the plugins submission or grade.

Parameters

string	$name	Name of the field.
string	$value	Updated text
int	$submissionorgradeid	The id of the submission or grade

Return values

bool	- true if the value was updated

Reimplemented in assign_feedback_comments.

◆ set_error()

assign_plugin::set_error ( $msg )

finalprotectedinherited

Save the error message from the last error.

Parameters

string $msg - the error description

◆ settings_validation()

assign_plugin::settings_validation	(	array	$data,
		array	$files )

inherited

This method is called when the mod_assign_mod_form is submitted.

It is an opportunity to validate the settings form fields added by {

See also: get_settings()}.

Parameters

array	$data	as passed to mod_assign_mod_form\validation().
array	$files	as passed to mod_assign_mod_form\validation().

Return values

array and validation errors that should be displayed. This is array_merged with any other validation errors from the form.

◆ submission_is_empty()

assign_submission_plugin::submission_is_empty ( stdClass $data )

inherited

Determine if a submission is empty.

This is distinct from is_empty in that it is intended to be used to determine if a submission made before saving is empty.

Parameters

stdClass $data The submission data

Return values

bool

Reimplemented in assign_submission_file, and assign_submission_onlinetext.

◆ submission_summary_for_messages()

assign_submission_plugin::submission_summary_for_messages ( stdClass $submission )

inherited

Summarise a submission for inclusion in messages.

Moodle messages can be sent as either HTML or plain text, so you need to produce two versions of the summary.

If there is nothing in the submission from your plugin return an array of two empty strings.

The plain text version should finish in a newline character. The HTML version should have block-level elements like headings or

s as the outer elements.

Parameters

stdClass $submission the assign_submission record for the submission the message is about.

Return values

string[] with two elements, a plain text summary and an HTML summary.

Reimplemented in assign_submission_file, and assign_submission_onlinetext.

◆ submit_for_grading()

assign_submission_plugin::submit_for_grading ( $submission )

inherited

Carry out any extra processing required when the work is submitted for grading.

Parameters

stdClass $submission the assign_submission record being submitted.

Return values

void

◆ unlock()

assign_submission_plugin::unlock	(		$submission,
		stdClass	$flags )

inherited

Carry out any extra processing required when the work is unlocked.

Parameters

stdClass \| false	$submission	- assign_submission data if any
stdClass	$flags	- User flags record

Return values

void

◆ upgrade()

assign_submission_comments::upgrade	(	context	$oldcontext,
		stdClass	$oldassignment,
		stdClass	$oldsubmission,
		stdClass	$submission,
		&	$log )

Upgrade the submission from the old assignment to the new one.

Parameters

context	$oldcontext	The context for the old assignment
stdClass	$oldassignment	The data record for the old assignment
stdClass	$oldsubmission	The data record for the old submission
stdClass	$submission	The new submission record
string	$log	Record upgrade messages in the log

Return values

bool	true or false - false will trigger a rollback

Reimplemented from assign_plugin.

◆ upgrade_settings()

assign_submission_comments::upgrade_settings	(	context	$oldcontext,
		stdClass	$oldassignment,
		&	$log )

Upgrade the settings from the old assignment to the new plugin based one.

Parameters

context	$oldcontext	- the context for the old assignment
stdClass	$oldassignment	- the data for the old assignment
string	$log	- can be appended to by the upgrade

Return values

bool	was it a success? (false will trigger a rollback)

Reimplemented from assign_plugin.

◆ view()

assign_plugin::view ( stdClass $submissionorgrade )

inherited

Should not output anything - return the result as a string so it can be consumed by webservices.

Parameters

stdClass $submissionorgrade assign_submission or assign_grade For submission plugins this is the submission data, for feedback plugins it is the grade data

Return values

string - return a string representation of the submission in full

Reimplemented in assign_feedback_comments, assign_feedback_editpdf, assign_feedback_file, assign_submission_file, and assign_submission_onlinetext.

◆ view_header()

assign_plugin::view_header ( )

inherited

This allows a plugin to render an introductory section which is displayed right below the activity's "intro" section on the main assignment page.

Return values

string

◆ view_page()

assign_plugin::view_page ( $action )

inherited

This allows a plugin to render a page in the context of the assignment.

If the plugin creates a link to the assignment view.php page with The following required parameters: id=coursemoduleid plugin=type pluginsubtype=assignfeedback|assignsubmission pluginaction=customaction

Then this function will be called to display the page with the pluginaction passed as action

Parameters

string $action The plugin specified action

Return values

string

Reimplemented in assign_feedback_file, and assign_feedback_offline.

◆ view_summary()

assign_submission_comments::view_summary	(	stdClass	$submission,
		&	$showviewlink )

Display AJAX based comment in the submission status table.

Parameters

stdClass	$submission
bool	$showviewlink	- If the comments are long this is set to true so they can be shown in a separate page

Return values

string

Reimplemented from assign_plugin.

The documentation for this class was generated from the following file:

mod/assign/submission/comments/locallib.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_attempt()

◆ allow_image_conversion()

◆ allow_submissions()

◆ can_upgrade()

◆ copy_submission()

◆ data_preprocessing()

◆ delete_instance()

◆ disable()

◆ enable()

◆ get_config()

◆ get_config_file_areas()

◆ get_config_for_external()

◆ get_editor_fields()

◆ get_editor_format()

◆ get_editor_text()

◆ get_error()

◆ get_external_parameters()

◆ get_file_areas()

◆ get_file_info()

◆ get_files()

◆ get_form_elements()

◆ get_form_elements_for_user()

◆ get_name()

◆ get_requires()

◆ get_settings()

◆ get_sort_order()

◆ get_subtype()

◆ get_type()

◆ get_version()

◆ has_admin_settings()

◆ has_user_summary()

◆ is_configurable()

◆ is_empty()

◆ is_enabled()

◆ is_first()

◆ is_last()

◆ is_visible()

◆ lock()

◆ precheck_submission()

◆ remove()

◆ revert_to_draft()

◆ save()

◆ save_settings()

◆ set_config()

◆ set_editor_format()

◆ set_editor_text()

◆ set_error()

◆ settings_validation()

◆ submission_is_empty()

◆ submission_summary_for_messages()

◆ submit_for_grading()

◆ unlock()

◆ upgrade()

◆ upgrade_settings()

◆ view()

◆ view_header()

◆ view_page()

◆ view_summary()