assign Class Reference

Standard base class for mod_assign (assignment types). More...

Public Member Functions
	__construct ($coursemodulecontext, $coursemodule, $course)
	Constructor for the base assign class. More...
	add_all_plugin_settings (MoodleQuickForm $mform)
	Add settings to edit plugin form. More...
	add_grade_form_elements (MoodleQuickForm $mform, stdClass $data, $params)
	Add elements to grade form. More...
	add_instance (stdClass $formdata, $callplugins)
	Add this instance to the database. More...
	add_submission_form_elements (MoodleQuickForm $mform, stdClass $data)
	Add elements to submission form. More...
	add_to_log ($action='', $info='', $url='', $return=false)
	Util function to add a message to the log. More...
	can_edit_group_submission ($groupid)
	Perform an access check to see if the current $USER can edit this group submission. More...
	can_edit_submission ($userid, $graderid=0)
	Capability check to make sure this grader can edit this submission. More...
	can_grade ($user=null)
	Does this user have grade permission for this assignment? More...
	can_upgrade ($type, $version)
	This function returns true if it can upgrade an assignment from the 2.2 module. More...
	can_view_grades ($groupid=null)
	Does this user have view grade or grade permission for this assignment? More...
	can_view_group_submission ($groupid)
	Perform an access check to see if the current $USER can view this group submission. More...
	can_view_submission ($userid)
	Perform an access check to see if the current $USER can view this users submission. More...
	copy_area_files_for_upgrade ($oldcontextid, $oldcomponent, $oldfilearea, $olditemid, $newcontextid, $newcomponent, $newfilearea, $newitemid)
	Copy all the files from the old assignment files area to the new one. More...
	copy_previous_attempt (&$notices)
	Copy the current assignment submission from the last submitted attempt. More...
	count_grades ()
	Load a count of grades. More...
	count_participants ($currentgroup)
	Load a count of active users enrolled in the current course with the specified permission and group. More...
	count_submissions ($includenew=false)
	Load a count of submissions. More...
	count_submissions_need_grading ($currentgroup=null)
	Load a count of active users submissions in the current module that require grading This means the submission modification time is more recent than the grading modification time and the status is SUBMITTED. More...
	count_submissions_with_status ($status, $currentgroup=null)
	Load a count of submissions with a specified status. More...
	count_teams ($activitygroup=0)
	Load a count of valid teams for this assignment. More...
	delete_all_overrides ()
	Deletes all assign overrides from the database and clears any corresponding calendar events.
	delete_instance ()
	Delete this instance from the database. More...
	delete_override ($overrideid)
	Deletes a assign override from the database and clears any corresponding calendar events. More...
	display_grade ($grade, $editing, $userid=0, $modified=0)
	Return a grade in user-friendly form, whether it's a scale or not. More...
	download_rewrite_pluginfile_urls ($text, $user, $plugin)
	Rewrite plugin file urls so they resolve correctly in an exported zip. More...
	format_grade_for_log (stdClass $grade)
	Take a grade object and print a short summary for the log file. More...
	format_submission_for_log (stdClass $submission)
	Take a submission object and print a short summary for the log file. More...
	fullname ($user)
	Get the name for a user - hiding their real name if blind marking is on. More...
	get_admin_config ()
	Load and cache the admin config for this module. More...
	get_all_groups ($userid)
	Gets all groups the user is a member of. More...
	get_all_submissions ($userid)
	Get the submissions for all previous attempts. More...
	get_assign_attempt_history_renderable ($user)
	Creates an assign_attempt_history renderable. More...
	get_assign_feedback_status_renderable ($user)
	Creates an assign_feedback_status renderable. More...
	get_assign_grading_summary_renderable ($activitygroup=null)
	Creates an assign_grading_summary renderable. More...
	get_assign_perpage ()
	Get the marking table page size. More...
	get_assign_submission_status_renderable ($user, $showlinks)
	Creates an assign_submission_status renderable. More...
	get_context ()
	Get context module. More...
	get_course ()
	Get the current course. More...
	get_course_context ()
	Get the context of the current course. More...
	get_course_module ()
	Get the current course module. More...
	get_default_instance ()
	Get the settings for the current instance of this assignment. More...
	get_feedback_plugin_by_type ($type)
	Get a feedback plugin by type. More...
	get_feedback_plugins ()
	Get list of feedback plugins installed. More...
	get_filters ()
	Return array of valid search filters for the grading interface. More...
	get_grade_item ()
	Get the primary grade item for this assign instance. More...
	get_grading_status ($userid)
	Returns the grading status. More...
	get_group_submission ($userid, $groupid, $create, $attemptnumber=-1)
	Load the group submission object for a particular user, optionally creating it if required. More...
	get_instance (int $userid=null)
	Get the settings for the current instance of this assignment. More...
	get_marking_allocation_filters ($export=false)
	Return array of valid grading allocation filters for the grading interface. More...
	get_marking_workflow_filters ($export=false)
	Return array of valid grading workflow filters for the grading interface. More...
	get_marking_workflow_states_for_current_user ()
	Get the list of marking_workflow states the current user has permission to transition a grade to. More...
	get_participant ($userid)
	Load a user if they are enrolled in the current course. More...
	get_plugin_by_type ($subtype, $type)
	Get a specific submission plugin by its type. More...
	get_renderer ()
	Lazy load the page renderer and expose the renderer to plugins. More...
	get_return_action ()
	Return an action that can be used to get back to the current page. More...
	get_return_params ()
	Return a list of parameters that can be used to get back to the current page. More...
	get_shared_group_members ($cm, $userid)
	Returns IDs of the users who share group membership with the specified user. More...
	get_submission_group ($userid)
	This is used for team assignments to get the group for the specified user. More...
	get_submission_group_members ($groupid, $onlyids, $excludesuspended=false)
	Get a list of the users in the same group as this user. More...
	get_submission_group_members_who_have_not_submitted ($groupid, $onlyids)
	Get a list of the users in the same group as this user that have not submitted the assignment. More...
	get_submission_plugin_by_type ($type)
	Get a submission plugin by type. More...
	get_submission_plugins ()
	Get list of submission plugins installed. More...
	get_uniqueid_for_user ($userid)
	Call the static version of this function. More...
	get_user_flags ($userid, $create)
	This will retrieve a user flags object from the db optionally creating it if required. More...
	get_user_grade ($userid, $create, $attemptnumber=-1)
	This will retrieve a grade object from the db, optionally creating it if required. More...
	get_user_grades_for_gradebook ($userid)
	Get an upto date list of user grades and feedback for the gradebook. More...
	get_user_id_for_uniqueid ($uniqueid)
	Call the static version of this function. More...
	get_user_submission ($userid, $create, $attemptnumber=-1)
	Load the submission object for a particular user, optionally creating it if required. More...
	get_useridlist_key ($id=null)
	Generates the key that should be used for an entry in the useridlist cache. More...
	get_useridlist_key_id ()
	The id used to uniquily identify the cache for this instance of the assign object. More...
	get_valid_calendar_event_timestart_range (\calendar_event $event)
	This function calculates the minimum and maximum cutoff values for the timestart of the given event. More...
	grading_disabled ($userid, $checkworkflow=true)
	Determine if this users grade can be edited. More...
	has_instance ()
	Has this assignment been constructed from an instance? More...
	has_overrides ()
	Returns whether an assign has any overrides. More...
	has_submissions_or_grades ()
	Does an assignment have submission(s) or grade(s) already? More...
	is_active_user ($userid)
	Return true is user is active user in course else false. More...
	is_any_feedback_plugin_enabled ()
	Check if feedback plugins installed are enabled. More...
	is_any_submission_plugin_enabled ()
	Check if submission plugins installed are enabled. More...
	is_blind_marking ()
	Is blind marking enabled and reveal identities not set yet? More...
	is_gradebook_feedback_enabled ()
	Returns true if gradebook feedback plugin is enabled. More...
	is_hidden_grader ()
	Is hidden grading enabled? More...
	is_override_calendar_event (\calendar_event $event)
	Check if the given calendar_event is either a user or group override event. More...
	list_participants ($currentgroup, $idsonly, $tablesort=false)
	Load a list of users enrolled in the current course with the specified permission and group. More...
	list_participants_with_filter_status_and_group ($currentgroup, $tablesort=false)
	Get the submission status/grading status for all submissions in this assignment. More...
	load_plugins ($subtype)
	Load the plugins from the sub folders under subtype. More...
	lock_submission ($userid)
	Prevent student updates to this submission. More...
	new_submission_empty ($data)
	Determine if a new submission is empty or not. More...
	notify_grade_modified ($grade, $mailedoverride=false)
	Mark in the database that this grade record should have an update notification sent by cron. More...
	override_exists ($userid)
	Returns user override. More...
	plugin_data_preprocessing (&$defaultvalues)
	Allow each plugin an opportunity to update the defaultvalues passed in to the settings form (needed to set up draft areas for editor and filemanager elements) More...
	register_return_link ($action, $params)
	Set the action and parameters that can be used to return to the current page. More...
	remove_submission ($userid)
	Remove any data from the current submission. More...
	render_area_files ($component, $area, $submissionid)
	Render the files in file area. More...
	render_editor_content ($filearea, $submissionid, $plugintype, $editor, $component, $shortentext=false)
	Render the content in editor that is often used by plugin. More...
	require_view_grades ()
	Throw an error if the permissions to view grades in this assignment are missing. More...
	require_view_group_submission ($groupid)
	Throw an error if the permissions to view this users' group submission are missing. More...
	require_view_submission ($userid)
	Throw an error if the permissions to view this users submission are missing. More...
	reset_userdata ($data)
	Actual implementation of the reset course functionality, delete all the assignment submissions for course $data->courseid. More...
	reveal_identities ()
	Reveal student identities to markers (and the gradebook). More...
	revert_to_draft ($userid)
	Revert to draft. More...
	save_grade ($userid, $data)
	Save grade update. More...
	save_submission (stdClass $data, & $notices)
	Save assignment submission for the current user. More...
	save_user_extension ($userid, $extensionduedate)
	Save the extension date for a single user. More...
	send_notification ($userfrom, $userto, $messagetype, $eventtype, $updatetime)
	Message someone about something. More...
	set_context (context $context)
	Set the context. More...
	set_course (stdClass $course)
	Set the course data. More...
	set_instance (stdClass $data)
	Set the submitted form data. More...
	set_module_viewed ()
	Update the module completion status (set it viewed) and trigger module viewed event. More...
	set_most_recent_team_submission ($submission)
	Set the most recent submission for the team. More...
	show_intro ()
	Based on the current assignment settings should we display the intro. More...
	show_only_active_users ()
	Check is only active users in course should be shown. More...
	submission_empty ($submission)
	Determine if the current submission is empty or not. More...
	submissions_open ($userid=0, $skipenrolled=false, $submission=false, $flags=false, $gradinginfo=false)
	Is this assignment open for submissions? More...
	submit_for_grading ($data, $notices)
	Submit a submission for grading. More...
	unlock_submission ($userid)
	Unlock the student submission. More...
	update_calendar ($coursemoduleid)
	Update the calendar entries for this assignment. More...
	update_effective_access ($userid)
	Updates the assign properties with override information for a user. More...
	update_grade ($grade, $reopenattempt=false)
	Update a grade in the grade table for the assignment and in the gradebook. More...
	update_gradebook ($reset, $coursemoduleid)
	Update the gradebook information for this assignment. More...
	update_instance ($formdata)
	Update this instance in the database. More...
	update_user_flags ($flags)
	Update user flags for this user in this assignment. More...
	view ($action='', $args=array())
	Display the assignment, used by view.php. More...
	view_batch_markingallocation ($mform)
	Shows a form that allows the allocated marker for selected submissions to be changed. More...
	view_student_summary ($user, $showlinks)
	Print 2 tables of information with no action links - the submission summary and the grading summary. More...

Static Public Member Functions
static	allocate_unique_ids ($assignid)
	Foreach participant in the course - assign them a random id. More...
static	can_upgrade_assignment ($type, $version)
	This function is a static wrapper around can_upgrade. More...
static	cron ()
	Finds all assignment notifications that have yet to be mailed out, and mails them. More...
static	get_uniqueid_for_user_static ($assignid, $userid)
	Lookup this user id and return the unique id for this assignment. More...
static	get_user_id_for_uniqueid_static ($assignid, $uniqueid)
	Lookup this unique id and return the user id for this assignment. More...
static	send_assignment_notification ($userfrom, $userto, $messagetype, $eventtype, $updatetime, $coursemodule, $context, $course, $modulename, $assignmentname, $blindmarking, $uniqueidforuser)
	Message someone about something (static so it can be called from cron). More...

Protected Member Functions
	add_attempt ($userid)
	Add a new attempt for a user. More...
	add_grade_notices ()
	Checks for any grade notices, and adds notifications. More...
	add_plugin_grade_elements ($grade, MoodleQuickForm $mform, stdClass $data, $userid)
	Add elements in grading plugin form. More...
	add_plugin_settings (assign_plugin $plugin, MoodleQuickForm $mform, & $pluginsenabled)
	Add one plugins settings to edit plugin form. More...
	add_plugin_submission_elements ($submission, MoodleQuickForm $mform, stdClass $data, $userid)
	Add elements in submission plugin form. More...
	apply_grade_to_user ($formdata, $userid, $attemptnumber)
	Apply a grade from a grading form to a user (may be called multiple times for a group submission). More...
	check_submit_for_grading ($mform)
	Ask the user to confirm they want to submit their work for grading. More...
	convert_grade_for_gradebook (stdClass $grade)
	Convert the final raw grade(s) in the grading table for the gradebook. More...
	convert_submission_for_gradebook (stdClass $submission)
	Convert submission details for the gradebook. More...
	count_attachments ()
	Count the number of intro attachments. More...
	delete_grades ()
	Delete all grades from the gradebook for this assignment. More...
	download_submissions ($userids=false)
	Download a zip file of all assignment submissions. More...
	fix_null_grades ()
	View fix rescaled null grades. More...
	get_all_grades ($userid)
	Get the grades for all previous attempts. More...
	get_error_messages ()
	Get error messages. More...
	get_grade ($gradeid)
	This will retrieve a grade object from the db. More...
	get_graders ($userid)
	Returns a list of teachers that should be grading given submission. More...
	get_grading_instance ($userid, $grade, $gradingdisabled)
	Get an instance of a grading form if advanced grading is enabled. More...
	get_grading_userid_list ($cached=false, $useridlistid='')
	Utility function to get the userid for every row in the grading table so the order can be frozen while we iterate it. More...
	get_module_name ()
	Get the name of the current module. More...
	get_module_name_plural ()
	Get the plural name of the current module. More...
	get_notifiable_users ($userid)
	Returns a list of users that should receive notification about given submission. More...
	get_submission ($submissionid)
	Load the submission object from it's id. More...
	get_submissionstatement ($adminconfig, $instance, $context)
	Get the correct submission statement depending on single submisison, team submission or team submission where all team memebers must submit. More...
	gradebook_item_update ($submission=null, $grade=null)
	Update grades in the gradebook. More...
	has_visible_attachments ()
	Are there any intro attachments to display? More...
	is_graded ($userid)
	See if this assignment has a grade yet. More...
	notify_graders (stdClass $submission)
	Send notifications to graders upon student submissions. More...
	notify_student_submission_copied (stdClass $submission)
	Notify student upon successful submission copy. More...
	notify_student_submission_receipt (stdClass $submission)
	Notify student upon successful submission. More...
	pack_files ($filesforzipping)
	Generate zip file from array of given files. More...
	plagiarism_print_disclosure ()
	Capture the output of the plagiarism plugins disclosures and return it as a string. More...
	process_add_attempt ($userid)
	Check for a sess key and then call add_attempt. More...
	process_add_attempt_group ($useridlist)
	Add a new attempt for each user in the list - but reopen each group assignment at most 1 time. More...
	process_copy_previous_attempt (&$notices)
	Require a valid sess key and then call copy_previous_attempt. More...
	process_grading_batch_operation (& $mform)
	Ask the user to confirm they want to perform this batch operation. More...
	process_lock_submission ($userid=0)
	Prevent student updates to this submission. More...
	process_outcomes ($userid, $formdata, $sourceuserid=null)
	Save outcomes submitted from grading form. More...
	process_remove_submission ($userid=0)
	Remove the current submission. More...
	process_reveal_identities ()
	Reveal student identities to markers (and the gradebook). More...
	process_revert_to_draft ($userid=0)
	Revert to draft. More...
	process_save_extension (& $mform)
	Save extension date. More...
	process_save_grade (&$mform)
	Save grade. More...
	process_save_grading_options ()
	Save grading options. More...
	process_save_quick_grades ()
	Save quick grades. More...
	process_save_submission (&$mform, &$notices)
	Save assignment submission. More...
	process_set_batch_marking_allocation ()
	Set the marking allocation for multiple users. More...
	process_set_batch_marking_workflow_state ()
	Set the workflow state for multiple users. More...
	process_submit_for_grading ($mform, $notices)
	Assignment submission is processed before grading. More...
	process_submit_other_for_grading ($mform, $notices)
	A students submission is submitted for grading by a teacher. More...
	process_unlock_submission ($userid=0)
	Unlock the student submission. More...
	reopen_submission_if_required ($userid, $submission, $addattempt)
	If the requirements are met - reopen the submission for another attempt. More...
	save_intro_draft_files ($formdata)
	Save the attachments in the draft areas. More...
	set_error_message (string $message)
	Set error message. More...
	show_submit_button ($submission=null, $teamsubmission=null, $userid=null)
	Returns true if the submit subsission button should be shown to the user. More...
	update_activity_completion_records ($teamsubmission, $requireallteammemberssubmit, $submission, $userid, $complete, $completion)
	Updates and creates the completion records in mdl_course_modules_completion. More...
	update_plugin_instance (assign_plugin $plugin, stdClass $formdata)
	Update the settings for a single plugin. More...
	update_submission (stdClass $submission, $userid, $updatetime, $teamsubmission)
	Update grades in the gradebook based on submission time. More...
	update_team_submission (stdClass $submission, $userid, $updatetime)
	Update team submission. More...
	view_batch_set_workflow_state ($mform)
	Shows a form that allows the workflow state for selected submissions to be changed. More...
	view_edit_submission_page ($mform, $notices)
	View edit submissions page. More...
	view_fix_rescaled_null_grades ()
	View fix rescaled null grades. More...
	view_footer ()
	Display the page footer. More...
	view_grader ()
	View entire grader app. More...
	view_grading_page ()
	View entire grading page. More...
	view_grading_table ()
	View the grading table of all submissions for this assignment. More...
	view_grant_extension ($mform)
	View the grant extension date page. More...
	view_notices ($title, $notices)
	Message for students when assignment submissions have been closed. More...
	view_plugin_content ($pluginsubtype)
	Display the submission that is used by a plugin. More...
	view_plugin_grading_batch_operation ($mform)
	Allows the plugin to show a batch grading operation page. More...
	view_plugin_page ()
	View a page rendered by a plugin. More...
	view_quickgrading_result ($message)
	Display a continue page after quickgrading. More...
	view_remove_submission_confirm ()
	Show a confirmation page to make sure they want to remove submission data. More...
	view_return_links ()
	View a link to go back to the previous page. More...
	view_reveal_identities_confirm ()
	Show a confirmation page to make sure they want to release student identities. More...
	view_savegrading_result ($message)
	Display a continue page after grading. More...
	view_single_grade_page ($mform)
	Print the grading page for a single user submission. More...
	view_single_grading_panel ($args)
	Print the grading page for a single user submission. More...
	view_submission_page ()
	View submissions page (contains details of current submission). More...

Static Protected Member Functions
static	format_notification_message_html ($messagetype, $info, $course, $context, $modulename, $coursemodule, $assignmentname)
	Format a notification for HTML. More...
static	format_notification_message_text ($messagetype, $info, $course, $context, $modulename, $assignmentname)
	Format a notification for plain text. More...

Detailed Description

Standard base class for mod_assign (assignment types).

Copyright

2012 NetSpot http://www.netspot.com.au

License

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

Constructor & Destructor Documentation

__construct()

assign::__construct	(		$coursemodulecontext,
			$coursemodule,
			$course
	)

Constructor for the base assign class.

Note: For $coursemodule you can supply a stdclass if you like, but it will be more efficient to supply a cm_info object.

Parameters

mixed	$coursemodulecontext	context|null the course module context (or the course context if the coursemodule has not been created yet).
mixed	$coursemodule	the current course module if it was already loaded, otherwise this class will load one from the context as required.
mixed	$course	the current course if it was already loaded, otherwise this class will load one from the context as required.

Member Function Documentation

add_all_plugin_settings()

assign::add_all_plugin_settings

(

MoodleQuickForm

$mform

)

Add settings to edit plugin form.

Parameters

MoodleQuickForm

$mform

The form to add the configuration settings to. This form is modified directly (not returned).

Return values

void

add_attempt()

assign::add_attempt (   $userid )

protected

Add a new attempt for a user.

Parameters

int

$userid

int The user to add the attempt for

Return values

bool	- true if successful.

add_grade_form_elements()

assign::add_grade_form_elements	(	MoodleQuickForm	$mform,
		stdClass	$data,
			$params
	)

Add elements to grade form.

Parameters

MoodleQuickForm	$mform
stdClass	$data
array	$params

Return values

void

add_grade_notices()

assign::add_grade_notices ( )

protected

Checks for any grade notices, and adds notifications.

Will display on assignment main page and grading table.

Return values

void	The notifications API will render the notifications at the appropriate part of the page.

add_instance()

assign::add_instance	(	stdClass	$formdata,
			$callplugins
	)

Add this instance to the database.

Parameters

stdClass	$formdata	The data submitted from the form
bool	$callplugins	This is used to skip the plugin code when upgrading an old assignment to a new one (the plugins get called manually)

Return values

mixed

false if an error occurs or the int id of the new instance

add_plugin_grade_elements()

assign::add_plugin_grade_elements (   $grade, MoodleQuickForm  $mform, stdClass  $data,   $userid  )

protected

Add elements in grading plugin form.

Parameters

mixed	$grade	stdClass|null
MoodleQuickForm	$mform
stdClass	$data
int	$userid	- The userid we are grading

Return values

void

add_plugin_settings()

assign::add_plugin_settings ( assign_plugin  $plugin, MoodleQuickForm  $mform, &  $pluginsenabled  )

protected

Add one plugins settings to edit plugin form.

Parameters

assign_plugin	$plugin	The plugin to add the settings from
MoodleQuickForm	$mform	The form to add the configuration settings to. This form is modified directly (not returned).
array	$pluginsenabled	A list of form elements to be added to a group. The new element is added to this array by this function.

Return values

void

add_plugin_submission_elements()

assign::add_plugin_submission_elements (   $submission, MoodleQuickForm  $mform, stdClass  $data,   $userid  )

protected

Add elements in submission plugin form.

Parameters

mixed	$submission	stdClass|null
MoodleQuickForm	$mform
stdClass	$data
int	$userid	The current userid (same as $USER->id)

Return values

void

add_submission_form_elements()

assign::add_submission_form_elements	(	MoodleQuickForm	$mform,
		stdClass	$data
	)

Add elements to submission form.

Parameters

MoodleQuickForm	$mform
stdClass	$data

Return values

void

add_to_log()

assign::add_to_log	(		$action = '',
			$info = '',
			$url = '',
			$return = false
	)

Util function to add a message to the log.

Deprecated:

since 2.7 - Use new events system instead. (see http://docs.moodle.org/dev/Migrating_logging_calls_in_plugins).

Parameters

string	$action	The current action
string	$info	A detailed description of the change. But no more than 255 characters.
string	$url	The url to the assign module instance.
bool	$return	If true, returns the arguments, else adds to log. The purpose of this is to retrieve the arguments to use them with the new event system (Event 2).

Return values

void|array

allocate_unique_ids()

static assign::allocate_unique_ids (   $assignid )

static

Foreach participant in the course - assign them a random id.

Parameters

int

$assignid

The assignid to lookup

apply_grade_to_user()

assign::apply_grade_to_user (   $formdata,   $userid,   $attemptnumber  )

protected

Apply a grade from a grading form to a user (may be called multiple times for a group submission).

Parameters

stdClass	$formdata	- the data from the form
int	$userid	- the user to apply the grade to
int	$attemptnumber	- The attempt number to apply the grade to.

Return values

void

can_edit_group_submission()

assign::can_edit_group_submission

(

$groupid

)

Perform an access check to see if the current $USER can edit this group submission.

Parameters

int

$groupid

Return values

bool

can_edit_submission()

assign::can_edit_submission	(		$userid,
			$graderid = 0
	)

Capability check to make sure this grader can edit this submission.

Parameters

int	$userid	- The user whose submission is to be edited
int	$graderid	(optional) - The user who will do the editing (default to $USER->id).

Return values

bool

can_grade()

assign::can_grade

(

$user = null

)

Does this user have grade permission for this assignment?

Parameters

int | stdClass

$user

The object or id of the user who will do the editing (default to current user).

Return values

bool

can_upgrade()

assign::can_upgrade	(		$type,
			$version
	)

This function returns true if it can upgrade an assignment from the 2.2 module.

Parameters

string	$type	The plugin type
int	$version	The plugin version

Return values

bool

can_upgrade_assignment()

static assign::can_upgrade_assignment (   $type,   $version  )

static

This function is a static wrapper around can_upgrade.

Parameters

string	$type	The plugin type
int	$version	The plugin version

Return values

bool

can_view_grades()

assign::can_view_grades

(

$groupid = null

)

Does this user have view grade or grade permission for this assignment?

Parameters

mixed

$groupid

int|null when is set to a value, use this group instead calculating it

Return values

bool

can_view_group_submission()

assign::can_view_group_submission

(

$groupid

)

Perform an access check to see if the current $USER can view this group submission.

Parameters

int

$groupid

Return values

bool

can_view_submission()

assign::can_view_submission

(

$userid

)

Perform an access check to see if the current $USER can view this users submission.

Parameters

int

$userid

Return values

bool

check_submit_for_grading()

assign::check_submit_for_grading (   $mform )

protected

Ask the user to confirm they want to submit their work for grading.

Parameters

moodleform

$mform

- null unless form validation has failed

Return values

string

convert_grade_for_gradebook()

assign::convert_grade_for_gradebook ( stdClass  $grade )

protected

Convert the final raw grade(s) in the grading table for the gradebook.

Parameters

stdClass

$grade

Return values

array

convert_submission_for_gradebook()

assign::convert_submission_for_gradebook ( stdClass  $submission )

protected

Convert submission details for the gradebook.

Parameters

stdClass

$submission

Return values

array

copy_area_files_for_upgrade()

assign::copy_area_files_for_upgrade	(		$oldcontextid,
			$oldcomponent,
			$oldfilearea,
			$olditemid,
			$newcontextid,
			$newcomponent,
			$newfilearea,
			$newitemid
	)

Copy all the files from the old assignment files area to the new one.

This is used by the plugin upgrade code.

Parameters

int	$oldcontextid	The old assignment context id
int	$oldcomponent	The old assignment component ('assignment')
int	$oldfilearea	The old assignment filearea ('submissions')
int	$olditemid	The old submissionid (can be null e.g. intro)
int	$newcontextid	The new assignment context id
int	$newcomponent	The new assignment component ('assignment')
int	$newfilearea	The new assignment filearea ('submissions')
int	$newitemid	The new submissionid (can be null e.g. intro)

Return values

int	The number of files copied

copy_previous_attempt()

assign::copy_previous_attempt

(

&

$notices

)

Copy the current assignment submission from the last submitted attempt.

Parameters

array

$notices

Any error messages that should be shown to the user at the top of the edit submission form.

Return values

bool

count_attachments()

assign::count_attachments ( )

protected

Count the number of intro attachments.

Return values

int

count_grades()

assign::count_grades

(

)

Load a count of grades.

Return values

int	number of grades

count_participants()

assign::count_participants

(

$currentgroup

)

Load a count of active users enrolled in the current course with the specified permission and group.

0 for no group.

Parameters

int

$currentgroup

Return values

int	number of matching users

count_submissions()

assign::count_submissions

(

$includenew = false

)

Load a count of submissions.

Parameters

bool

$includenew

When true, also counts the submissions with status 'new'.

Return values

int	number of submissions

count_submissions_need_grading()

assign::count_submissions_need_grading

(

$currentgroup = null

)

Load a count of active users submissions in the current module that require grading This means the submission modification time is more recent than the grading modification time and the status is SUBMITTED.

Parameters

mixed

$currentgroup

int|null the group for counting (if null the function will determine it)

Return values

int	number of matching submissions

count_submissions_with_status()

assign::count_submissions_with_status	(		$status,
			$currentgroup = null
	)

Load a count of submissions with a specified status.

Parameters

string	$status	The submission status - should match one of the constants
mixed	$currentgroup	int|null the group for counting (if null the function will determine it)

Return values

int	number of matching submissions

count_teams()

assign::count_teams

(

$activitygroup = 0

)

Load a count of valid teams for this assignment.

Parameters

int

$activitygroup

Activity active group

Return values

int	number of valid teams

cron()

static assign::cron ( )

static

Finds all assignment notifications that have yet to be mailed out, and mails them.

Cron function to be run periodically according to the moodle cron.

Return values

bool

delete_grades()

assign::delete_grades ( )

protected

Delete all grades from the gradebook for this assignment.

Return values

bool

delete_instance()

assign::delete_instance

(

)

Delete this instance from the database.

Return values

bool	false if an error occurs

delete_override()

assign::delete_override

(

$overrideid

)

Deletes a assign override from the database and clears any corresponding calendar events.

Parameters

int

$overrideid

The id of the override being deleted

Return values

bool	true on success

display_grade()

assign::display_grade	(		$grade,
			$editing,
			$userid = 0,
			$modified = 0
	)

Return a grade in user-friendly form, whether it's a scale or not.

Parameters

mixed	$grade	int|null
boolean	$editing	Are we allowing changes to this grade?
int	$userid	The user id the grade belongs to
int	$modified	Timestamp from when the grade was last modified

Return values

string

User-friendly representation of grade

download_rewrite_pluginfile_urls()

assign::download_rewrite_pluginfile_urls	(		$text,
			$user,
			$plugin
	)

Rewrite plugin file urls so they resolve correctly in an exported zip.

Parameters

string	$text	- The replacement text
stdClass	$user	- The user record
assign_plugin	$plugin	- The assignment plugin

download_submissions()

assign::download_submissions (   $userids = false )

protected

Download a zip file of all assignment submissions.

Parameters

array

$userids

Array of user ids to download assignment submissions in a zip file

Return values

string

- If an error occurs, this will contain the error page.

fix_null_grades()

assign::fix_null_grades ( )

protected

View fix rescaled null grades.

Return values

bool	True if null all grades are now fixed.

format_grade_for_log()

assign::format_grade_for_log

(

stdClass

$grade

)

Take a grade object and print a short summary for the log file.

The size limit for the log file is 255 characters, so be careful not to include too much information.

Deprecated:

since 2.7

Parameters

stdClass

$grade

Return values

string

format_notification_message_html()

static assign::format_notification_message_html (   $messagetype,   $info,   $course,   $context,   $modulename,   $coursemodule,   $assignmentname  )

staticprotected

Format a notification for HTML.

Parameters

string	$messagetype
stdClass	$info
stdClass	$course
stdClass	$context
string	$modulename
stdClass	$coursemodule
string	$assignmentname

format_notification_message_text()

static assign::format_notification_message_text (   $messagetype,   $info,   $course,   $context,   $modulename,   $assignmentname  )

staticprotected

Format a notification for plain text.

Parameters

string	$messagetype
stdClass	$info
stdClass	$course
stdClass	$context
string	$modulename
string	$assignmentname

format_submission_for_log()

assign::format_submission_for_log

(

stdClass

$submission

)

Take a submission object and print a short summary for the log file.

The size limit for the log file is 255 characters, so be careful not to include too much information.

Deprecated:

since 2.7

Parameters

stdClass

$submission

Return values

string

fullname()

assign::fullname

(

$user

)

Get the name for a user - hiding their real name if blind marking is on.

Parameters

stdClass

$user

The user record as required by fullname()

Return values

string

The name.

get_admin_config()

assign::get_admin_config

(

)

Load and cache the admin config for this module.

Return values

stdClass

the plugin config

get_all_grades()

assign::get_all_grades (   $userid )

protected

Get the grades for all previous attempts.

For each grade - the grader is a full user record, and gradefordisplay is added (rendered from grading manager).

Parameters

int

$userid

If not set, $USER->id will be used.

Return values

array::$grades

All grade records for this user.

get_all_groups()

assign::get_all_groups

(

$userid

)

Gets all groups the user is a member of.

Parameters

int

$userid

Teh id of the user who's groups we are checking

Return values

array

The group objects

get_all_submissions()

assign::get_all_submissions

(

$userid

)

Get the submissions for all previous attempts.

Parameters

int

$userid

If not set, $USER->id will be used.

Return values

array::$submissions

All submission records for this user (or group).

get_assign_attempt_history_renderable()

assign::get_assign_attempt_history_renderable

(

$user

)

Creates an assign_attempt_history renderable.

Parameters

stdClass

$user

the user to get the report for

Return values

assign_attempt_history

renderable object

get_assign_feedback_status_renderable()

assign::get_assign_feedback_status_renderable

(

$user

)

Creates an assign_feedback_status renderable.

Parameters

stdClass

$user

the user to get the report for

Return values

assign_feedback_status

renderable object

get_assign_grading_summary_renderable()

assign::get_assign_grading_summary_renderable

(

$activitygroup = null

)

Creates an assign_grading_summary renderable.

Parameters

mixed

$activitygroup

int|null the group for calculating the grading summary (if null the function will determine it)

Return values

assign_grading_summary

renderable object

get_assign_perpage()

assign::get_assign_perpage

(

)

Get the marking table page size.

Return values

integer

get_assign_submission_status_renderable()

assign::get_assign_submission_status_renderable	(		$user,
			$showlinks
	)

Creates an assign_submission_status renderable.

Parameters

stdClass	$user	the user to get the report for
bool	$showlinks	return plain text or links to the profile

Return values

assign_submission_status

renderable object

get_context()

assign::get_context

(

)

Get context module.

Return values

context

get_course()

assign::get_course

(

)

Get the current course.

Return values

mixed

stdClass|null The course

get_course_context()

assign::get_course_context

(

)

Get the context of the current course.

Return values

mixed

context|null The course context

get_course_module()

assign::get_course_module

(

)

Get the current course module.

Return values

cm_info|null

The course module or null if not known

get_default_instance()

assign::get_default_instance

(

)

Get the settings for the current instance of this assignment.

Return values

stdClass

The settings

Exceptions

dml_exception

get_error_messages()

assign::get_error_messages ( )

protected

Get error messages.

Return values

array

The array of error messages

get_feedback_plugin_by_type()

assign::get_feedback_plugin_by_type

(

$type

)

Get a feedback plugin by type.

Parameters

string

$type

- The type of plugin e.g comments

Return values

mixed

assign_feedback_plugin|null

get_feedback_plugins()

assign::get_feedback_plugins

(

)

Get list of feedback plugins installed.

Return values

array

get_filters()

assign::get_filters

(

)

Return array of valid search filters for the grading interface.

Return values

array

get_grade()

assign::get_grade (   $gradeid )

protected

This will retrieve a grade object from the db.

Parameters

int

$gradeid

The id of the grade

Return values

stdClass

The grade record

get_grade_item()

assign::get_grade_item

(

)

Get the primary grade item for this assign instance.

Return values

grade_item

The grade_item record

get_graders()

assign::get_graders (   $userid )

protected

Returns a list of teachers that should be grading given submission.

Parameters

int

$userid

The submission to grade

Return values

array

get_grading_instance()

assign::get_grading_instance (   $userid,   $grade,   $gradingdisabled  )

protected

Get an instance of a grading form if advanced grading is enabled.

This is specific to the assignment, marker and student.

Parameters

int	$userid	- The student userid
stdClass | false	$grade	- The grade record
bool	$gradingdisabled

Return values

mixed

gradingform_instance|null $gradinginstance

get_grading_status()

assign::get_grading_status

(

$userid

)

Returns the grading status.

Parameters

int

$userid

the user id

Return values

string

returns the grading status

get_grading_userid_list()

assign::get_grading_userid_list (   $cached = false,   $useridlistid = ''  )

protected

Utility function to get the userid for every row in the grading table so the order can be frozen while we iterate it.

Parameters

boolean	$cached	If true, the cached list from the session could be returned.
string	$useridlistid	String value used for caching the participant list.

Return values

array

An array of userids

get_group_submission()

assign::get_group_submission	(		$userid,
			$groupid,
			$create,
			$attemptnumber = -1
	)

Load the group submission object for a particular user, optionally creating it if required.

Parameters

int	$userid	The id of the user whose submission we want
int	$groupid	The id of the group for this user - may be 0 in which case it is determined from the userid.
bool	$create	If set to true a new submission object will be created in the database with the status set to "new".
int	$attemptnumber	- -1 means the latest attempt

Return values

stdClass

The submission

get_instance()

assign::get_instance

(

int

$userid = null

)

Get the settings for the current instance of this assignment.

Parameters

int | null

$userid

the id of the user to load the assign instance for.

Return values

stdClass

The settings

get_marking_allocation_filters()

assign::get_marking_allocation_filters

(

$export = false

)

Return array of valid grading allocation filters for the grading interface.

Parameters

boolean

$export

Export the list of filters for a template.

Return values

array

get_marking_workflow_filters()

assign::get_marking_workflow_filters

(

$export = false

)

Return array of valid grading workflow filters for the grading interface.

Parameters

boolean

$export

Export the list of filters for a template.

Return values

array

get_marking_workflow_states_for_current_user()

assign::get_marking_workflow_states_for_current_user

(

)

Get the list of marking_workflow states the current user has permission to transition a grade to.

Return values

array

of state => description

get_module_name()

assign::get_module_name ( )

protected

Get the name of the current module.

Return values

string

the module name (Assignment)

get_module_name_plural()

assign::get_module_name_plural ( )

protected

Get the plural name of the current module.

Return values

string

the module name plural (Assignments)

get_notifiable_users()

assign::get_notifiable_users (   $userid )

protected

Returns a list of users that should receive notification about given submission.

Parameters

int

$userid

The submission to grade

Return values

array

get_participant()

assign::get_participant

(

$userid

)

Load a user if they are enrolled in the current course.

Populated with submission status for this assignment.

Parameters

int

$userid

Return values

null|stdClass

user record

get_plugin_by_type()

assign::get_plugin_by_type	(		$subtype,
			$type
	)

Get a specific submission plugin by its type.

Parameters

string	$subtype	assignsubmission | assignfeedback
string	$type

Return values

mixed

assign_plugin|null

get_renderer()

assign::get_renderer

(

)

Lazy load the page renderer and expose the renderer to plugins.

Return values

assign_renderer

get_return_action()

assign::get_return_action

(

)

Return an action that can be used to get back to the current page.

Return values

string

action

get_return_params()

assign::get_return_params

(

)

Return a list of parameters that can be used to get back to the current page.

Return values

array

params

get_shared_group_members()

assign::get_shared_group_members	(		$cm,
			$userid
	)

Returns IDs of the users who share group membership with the specified user.

Parameters

stdClass | cm_info	$cm	Course-module
int	$userid	User ID

Return values

array

An array of ID of users.

get_submission()

assign::get_submission (   $submissionid )

protected

Load the submission object from it's id.

Parameters

int

$submissionid

The id of the submission we want

Return values

stdClass

The submission

get_submission_group()

assign::get_submission_group

(

$userid

)

This is used for team assignments to get the group for the specified user.

If the user is a member of multiple or no groups this will return false

Parameters

int

$userid

The id of the user whose submission we want

Return values

mixed

The group or false

get_submission_group_members()

assign::get_submission_group_members	(		$groupid,
			$onlyids,
			$excludesuspended = false
	)

Get a list of the users in the same group as this user.

Parameters

int	$groupid	The id of the group whose members we want or 0 for the default group
bool	$onlyids	Whether to retrieve only the user id's
bool	$excludesuspended	Whether to exclude suspended users

Return values

array

The users (possibly id's only)

get_submission_group_members_who_have_not_submitted()

assign::get_submission_group_members_who_have_not_submitted	(		$groupid,
			$onlyids
	)

Get a list of the users in the same group as this user that have not submitted the assignment.

Parameters

int	$groupid	The id of the group whose members we want or 0 for the default group
bool	$onlyids	Whether to retrieve only the user id's

Return values

array

The users (possibly id's only)

get_submission_plugin_by_type()

assign::get_submission_plugin_by_type

(

$type

)

Get a submission plugin by type.

Parameters

string

$type

- The type of plugin e.g comments

Return values

mixed

assign_submission_plugin|null

get_submission_plugins()

assign::get_submission_plugins

(

)

Get list of submission plugins installed.

Return values

array

get_submissionstatement()

assign::get_submissionstatement (   $adminconfig,   $instance,   $context  )

protected

Get the correct submission statement depending on single submisison, team submission or team submission where all team memebers must submit.

Parameters

array	$adminconfig
assign	$instance
context	$context

Return values

string

get_uniqueid_for_user()

assign::get_uniqueid_for_user

(

$userid

)

Call the static version of this function.

Parameters

int

$userid

The userid to lookup

Return values

int	The unique id

get_uniqueid_for_user_static()

static assign::get_uniqueid_for_user_static (   $assignid,   $userid  )

static

Lookup this user id and return the unique id for this assignment.

Parameters

int	$assignid	The assignment id
int	$userid	The userid to lookup

Return values

int	The unique id

get_user_flags()

assign::get_user_flags	(		$userid,
			$create
	)

This will retrieve a user flags object from the db optionally creating it if required.

The user flags was split from the user_grades table in 2.5.

Parameters

int	$userid	The user we are getting the flags for.
bool	$create	If true the flags record will be created if it does not exist

Return values

stdClass

The flags record

get_user_grade()

assign::get_user_grade	(		$userid,
			$create,
			$attemptnumber = -1
	)

This will retrieve a grade object from the db, optionally creating it if required.

Parameters

int	$userid	The user we are grading
bool	$create	If true the grade will be created if it does not exist
int	$attemptnumber	The attempt number to retrieve the grade for. -1 means the latest submission.

Return values

stdClass

The grade record

get_user_grades_for_gradebook()

assign::get_user_grades_for_gradebook

(

$userid

)

Get an upto date list of user grades and feedback for the gradebook.

Parameters

int

$userid

int or 0 for all users

Return values

array

of grade data formated for the gradebook api The data required by the gradebook api is userid, rawgrade, feedback, feedbackformat, usermodified, dategraded, datesubmitted

get_user_id_for_uniqueid()

assign::get_user_id_for_uniqueid

(

$uniqueid

)

Call the static version of this function.

Parameters

int

$uniqueid

The uniqueid to lookup

Return values

int	The user id or false if they don't exist

get_user_id_for_uniqueid_static()

static assign::get_user_id_for_uniqueid_static (   $assignid,   $uniqueid  )

static

Lookup this unique id and return the user id for this assignment.

Parameters

int	$assignid	The id of the assignment this user mapping is in
int	$uniqueid	The uniqueid to lookup

Return values

int	The user id or false if they don't exist

get_user_submission()

assign::get_user_submission	(		$userid,
			$create,
			$attemptnumber = -1
	)

Load the submission object for a particular user, optionally creating it if required.

For team assignments there are 2 submissions - the student submission and the team submission All files are associated with the team submission but the status of the students contribution is recorded separately.

Parameters

int	$userid	The id of the user whose submission we want or 0 in which case USER->id is used
bool	$create	If set to true a new submission object will be created in the database with the status set to "new".
int	$attemptnumber	- -1 means the latest attempt

Return values

stdClass

The submission

get_useridlist_key()

assign::get_useridlist_key

(

$id = null

)

Generates the key that should be used for an entry in the useridlist cache.

Parameters

string

$id

Generate a key for this instance (optional)

Return values

string

The key for the id, or new entry if no $id is passed.

get_useridlist_key_id()

assign::get_useridlist_key_id

(

)

The id used to uniquily identify the cache for this instance of the assign object.

Return values

string

get_valid_calendar_event_timestart_range()

assign::get_valid_calendar_event_timestart_range

(

\calendar_event

$event

)

This function calculates the minimum and maximum cutoff values for the timestart of the given event.

It will return an array with two values, the first being the minimum cutoff value and the second being the maximum cutoff value. Either or both values can be null, which indicates there is no minimum or maximum, respectively.

If a cutoff is required then the function must return an array containing the cutoff timestamp and error string to display to the user if the cutoff value is violated.

A minimum and maximum cutoff return value will look like: [ [1505704373, 'The due date must be after the sbumission start date'], [1506741172, 'The due date must be before the cutoff date'] ]

If the event does not have a valid timestart range then [false, false] will be returned.

Parameters

calendar_event

$event

The calendar event to get the time range for

Return values

array

gradebook_item_update()

assign::gradebook_item_update (   $submission = null,   $grade = null  )

protected

Update grades in the gradebook.

Parameters

mixed	$submission	stdClass|null
mixed	$grade	stdClass|null

Return values

bool

grading_disabled()

assign::grading_disabled	(		$userid,
			$checkworkflow = true
	)

Determine if this users grade can be edited.

Parameters

int	$userid	- The student userid
bool	$checkworkflow	- whether to include a check for the workflow state.

Return values

bool::$gradingdisabled

has_instance()

assign::has_instance

(

)

Has this assignment been constructed from an instance?

Return values

bool

has_overrides()

assign::has_overrides

(

)

Returns whether an assign has any overrides.

Return values

true	if any, false if not

has_submissions_or_grades()

assign::has_submissions_or_grades

(

)

Does an assignment have submission(s) or grade(s) already?

Return values

bool

has_visible_attachments()

assign::has_visible_attachments ( )

protected

Are there any intro attachments to display?

Return values

boolean

is_active_user()

assign::is_active_user

(

$userid

)

Return true is user is active user in course else false.

Parameters

int

$userid

Return values

bool	true is user is active in course.

is_any_feedback_plugin_enabled()

assign::is_any_feedback_plugin_enabled

(

)

Check if feedback plugins installed are enabled.

Return values

bool

is_any_submission_plugin_enabled()

assign::is_any_submission_plugin_enabled

(

)

Check if submission plugins installed are enabled.

Return values

bool

is_blind_marking()

assign::is_blind_marking

(

)

Is blind marking enabled and reveal identities not set yet?

Return values

bool

is_gradebook_feedback_enabled()

assign::is_gradebook_feedback_enabled

(

)

Returns true if gradebook feedback plugin is enabled.

Return values

bool	true if gradebook feedback plugin is enabled and visible else false.

is_graded()

assign::is_graded (   $userid )

protected

See if this assignment has a grade yet.

Parameters

int

$userid

Return values

bool

is_hidden_grader()

assign::is_hidden_grader

(

)

Is hidden grading enabled?

This just checks the assignment settings. Remember to check the user has the 'showhiddengrader' capability too

Return values

bool

is_override_calendar_event()

assign::is_override_calendar_event

(

\calendar_event

$event

)

Check if the given calendar_event is either a user or group override event.

Return values

bool

list_participants()

assign::list_participants	(		$currentgroup,
			$idsonly,
			$tablesort = false
	)

Load a list of users enrolled in the current course with the specified permission and group.

0 for no group. Apply any current sort filters from the grading table.

Parameters

int	$currentgroup
bool	$idsonly

Return values

array

List of user records

list_participants_with_filter_status_and_group()

assign::list_participants_with_filter_status_and_group	(		$currentgroup,
			$tablesort = false
	)

Get the submission status/grading status for all submissions in this assignment.

These statuses match the available filters (requiregrading, submitted, notsubmitted, grantedextension). If this is a group assignment, group info is also returned.

Parameters

int	$currentgroup
boolean	$tablesort	Apply current user table sorting preferences.

Return values

array

List of user records with extra fields 'submitted', 'notsubmitted', 'requiregrading', 'grantedextension', 'groupid', 'groupname'

load_plugins()

assign::load_plugins

(

$subtype

)

Load the plugins from the sub folders under subtype.

Parameters

string

$subtype

- either submission or feedback

Return values

array

- The sorted list of plugins

lock_submission()

assign::lock_submission

(

$userid

)

Prevent student updates to this submission.

Parameters

int

$userid

Return values

bool

new_submission_empty()

assign::new_submission_empty

(

$data

)

Determine if a new submission is empty or not.

Parameters

stdClass

$data

Submission data

Return values

bool

notify_grade_modified()

assign::notify_grade_modified	(		$grade,
			$mailedoverride = false
	)

Mark in the database that this grade record should have an update notification sent by cron.

Parameters

stdClass	$grade	a grade record keyed on id
bool	$mailedoverride	when true, flag notification to be sent again.

Return values

bool	true for success

notify_graders()

assign::notify_graders ( stdClass  $submission )

protected

Send notifications to graders upon student submissions.

Parameters

stdClass

$submission

Return values

void

notify_student_submission_copied()

assign::notify_student_submission_copied ( stdClass  $submission )

protected

Notify student upon successful submission copy.

Parameters

stdClass

$submission

Return values

void

notify_student_submission_receipt()

assign::notify_student_submission_receipt ( stdClass  $submission )

protected

Notify student upon successful submission.

Parameters

stdClass

$submission

Return values

void

override_exists()

assign::override_exists

(

$userid

)

Returns user override.

Algorithm: For each assign setting, if there is a matching user-specific override, then use that otherwise, if there are group-specific overrides, use the one with the lowest sort order. If neither applies, leave the assign setting unchanged.

Parameters

int

$userid

The userid.

Return values

stdClass

The override

pack_files()

assign::pack_files (   $filesforzipping )

protected

Generate zip file from array of given files.

Parameters

array

$filesforzipping

- array of files to pass into archive_to_pathname. This array is indexed by the final file name and each element in the array is an instance of a stored_file object.

Return values

path	of temp file - note this returned file does not have a .zip extension - it is a temp file.

plagiarism_print_disclosure()

assign::plagiarism_print_disclosure ( )

protected

Capture the output of the plagiarism plugins disclosures and return it as a string.

Return values

string

plugin_data_preprocessing()

assign::plugin_data_preprocessing

(

&

$defaultvalues

)

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

Parameters

array

$defaultvalues

process_add_attempt()

assign::process_add_attempt (   $userid )

protected

Check for a sess key and then call add_attempt.

Parameters

int

$userid

int The user to add the attempt for

Return values

bool	- true if successful.

process_add_attempt_group()

assign::process_add_attempt_group (   $useridlist )

protected

Add a new attempt for each user in the list - but reopen each group assignment at most 1 time.

Parameters

array

$useridlist

Array of userids to reopen.

Return values

bool

process_copy_previous_attempt()

assign::process_copy_previous_attempt ( &  $notices )

protected

Require a valid sess key and then call copy_previous_attempt.

Parameters

array

$notices

Any error messages that should be shown to the user at the top of the edit submission form.

Return values

bool

process_grading_batch_operation()

assign::process_grading_batch_operation ( &  $mform )

protected

Ask the user to confirm they want to perform this batch operation.

Parameters

moodleform

$mform

Set to a grading batch operations form

Return values

string

- the page to view after processing these actions

process_lock_submission()

assign::process_lock_submission (   $userid = 0 )

protected

Prevent student updates to this submission.

Uses url parameter userid.

Parameters

int

$userid

Return values

void

process_outcomes()

assign::process_outcomes (   $userid,   $formdata,   $sourceuserid = null  )

protected

Save outcomes submitted from grading form.

Parameters

int	$userid
stdClass	$formdata
int	$sourceuserid	The user ID under which the outcome data is accessible. This is relevant for an outcome set to a user but applied to an entire group.

process_remove_submission()

assign::process_remove_submission (   $userid = 0 )

protected

Remove the current submission.

Parameters

int

$userid

Return values

boolean

process_reveal_identities()

assign::process_reveal_identities ( )

protected

Reveal student identities to markers (and the gradebook).

Return values

void

process_revert_to_draft()

assign::process_revert_to_draft (   $userid = 0 )

protected

Revert to draft.

Uses url parameter userid if userid not supplied as a parameter.

Parameters

int

$userid

Return values

boolean

process_save_extension()

assign::process_save_extension ( &  $mform )

protected

Save extension date.

Parameters

moodleform

$mform

The submitted form

Return values

boolean

process_save_grade()

assign::process_save_grade ( &  $mform )

protected

Save grade.

Parameters

moodleform

$mform

Return values

bool	- was the grade saved

process_save_grading_options()

assign::process_save_grading_options ( )

protected

Save grading options.

Return values

void

process_save_quick_grades()

assign::process_save_quick_grades ( )

protected

Save quick grades.

Return values

string

The result of the save operation

process_save_submission()

assign::process_save_submission ( &  $mform, &  $notices  )

protected

Save assignment submission.

Parameters

moodleform	$mform
array	$notices	Any error messages that should be shown to the user at the top of the edit submission form.

Return values

bool

process_set_batch_marking_allocation()

assign::process_set_batch_marking_allocation ( )

protected

Set the marking allocation for multiple users.

Return values

void

process_set_batch_marking_workflow_state()

assign::process_set_batch_marking_workflow_state ( )

protected

Set the workflow state for multiple users.

Return values

void

process_submit_for_grading()

assign::process_submit_for_grading (   $mform,   $notices  )

protected

Assignment submission is processed before grading.

Parameters

moodleform | null

$mform

If validation failed when submitting this form - this is the moodleform. It can be null.

Return values

bool	Return false if the validation fails. This affects which page is displayed next.

process_submit_other_for_grading()

assign::process_submit_other_for_grading (   $mform,   $notices  )

protected

A students submission is submitted for grading by a teacher.

Return values

bool

process_unlock_submission()

assign::process_unlock_submission (   $userid = 0 )

protected

Unlock the student submission.

Uses url parameter userid.

Parameters

int

$userid

Return values

bool

register_return_link()

assign::register_return_link	(		$action,
			$params
	)

Set the action and parameters that can be used to return to the current page.

Parameters

string	$action	The action for the current page
array	$params	An array of name value pairs which form the parameters to return to the current page.

Return values

void

remove_submission()

assign::remove_submission

(

$userid

)

Remove any data from the current submission.

Parameters

int

$userid

Return values

boolean

render_area_files()

assign::render_area_files	(		$component,
			$area,
			$submissionid
	)

Render the files in file area.

Parameters

string	$component
string	$area
int	$submissionid

Return values

string

render_editor_content()

assign::render_editor_content	(		$filearea,
			$submissionid,
			$plugintype,
			$editor,
			$component,
			$shortentext = false
	)

Render the content in editor that is often used by plugin.

Parameters

string	$filearea
int	$submissionid
string	$plugintype
string	$editor
string	$component
bool	$shortentext	Whether to shorten the text content.

Return values

string

reopen_submission_if_required()

assign::reopen_submission_if_required (   $userid,   $submission,   $addattempt  )

protected

If the requirements are met - reopen the submission for another attempt.

Only call this function when grading the latest attempt.

Parameters

int	$userid	The userid.
stdClass	$submission	The submission (may be a group submission).
bool	$addattempt	- True if the "allow another attempt" checkbox was checked.

Return values

bool	- true if another attempt was added.

require_view_grades()

assign::require_view_grades

(

)

Throw an error if the permissions to view grades in this assignment are missing.

Exceptions

required_capability_exception

Return values

none

require_view_group_submission()

assign::require_view_group_submission

(

$groupid

)

Throw an error if the permissions to view this users' group submission are missing.

Parameters

int

$groupid

Group id.

Exceptions

required_capability_exception

require_view_submission()

assign::require_view_submission

(

$userid

)

Throw an error if the permissions to view this users submission are missing.

Exceptions

required_capability_exception

Return values

none

reset_userdata()

assign::reset_userdata

(

$data

)

Actual implementation of the reset course functionality, delete all the assignment submissions for course $data->courseid.

Parameters

stdClass

$data

the data submitted from the reset course.

Return values

array

status array

reveal_identities()

assign::reveal_identities

(

)

Reveal student identities to markers (and the gradebook).

Return values

void

revert_to_draft()

assign::revert_to_draft

(

$userid

)

Revert to draft.

Parameters

int

$userid

Return values

boolean

save_grade()

assign::save_grade	(		$userid,
			$data
	)

Save grade update.

Parameters

int	$userid
stdClass	$data

Return values

bool	- was the grade saved

save_intro_draft_files()

assign::save_intro_draft_files (   $formdata )

protected

Save the attachments in the draft areas.

Parameters

stdClass

$formdata

save_submission()

assign::save_submission	(	stdClass	$data,
		&	$notices
	)

Save assignment submission for the current user.

Parameters

stdClass	$data
array	$notices	Any error messages that should be shown to the user.

Return values

bool

save_user_extension()

assign::save_user_extension	(		$userid,
			$extensionduedate
	)

Save the extension date for a single user.

Parameters

int	$userid	The user id
mixed	$extensionduedate	Either an integer date or null

Return values

boolean

send_assignment_notification()

static assign::send_assignment_notification (   $userfrom,   $userto,   $messagetype,   $eventtype,   $updatetime,   $coursemodule,   $context,   $course,   $modulename,   $assignmentname,   $blindmarking,   $uniqueidforuser  )

static

Message someone about something (static so it can be called from cron).

Parameters

stdClass	$userfrom
stdClass	$userto
string	$messagetype
string	$eventtype
int	$updatetime
stdClass	$coursemodule
stdClass	$context
stdClass	$course
string	$modulename
string	$assignmentname
bool	$blindmarking
int	$uniqueidforuser

Return values

void

send_notification()

assign::send_notification	(		$userfrom,
			$userto,
			$messagetype,
			$eventtype,
			$updatetime
	)

Message someone about something.

Parameters

stdClass	$userfrom
stdClass	$userto
string	$messagetype
string	$eventtype
int	$updatetime

Return values

void

set_context()

assign::set_context

(

context

$context

)

Set the context.

Parameters

context

$context

The new context

set_course()

assign::set_course

(

stdClass

$course

)

Set the course data.

Parameters

stdClass

$course

The course data

set_error_message()

assign::set_error_message ( string  $message )

protected

Set error message.

Parameters

string

$message

The error message

set_instance()

assign::set_instance

(

stdClass

$data

)

Set the submitted form data.

Parameters

stdClass

$data

The form data (instance)

set_module_viewed()

assign::set_module_viewed

(

)

Update the module completion status (set it viewed) and trigger module viewed event.

Since

Moodle 3.2

set_most_recent_team_submission()

assign::set_most_recent_team_submission

(

$submission

)

Set the most recent submission for the team.

The most recent team submission is used to determine if another attempt should be created when allowing another attempt on a group assignment, and whether the gradebook should be updated.

Since

Moodle 3.4

Parameters

stdClass

$submission

The most recent submission of the group.

show_intro()

assign::show_intro

(

)

Based on the current assignment settings should we display the intro.

Return values

bool

showintro

show_only_active_users()

assign::show_only_active_users

(

)

Check is only active users in course should be shown.

Return values

bool	true if only active users should be shown.

show_submit_button()

assign::show_submit_button (   $submission = null,   $teamsubmission = null,   $userid = null  )

protected

Returns true if the submit subsission button should be shown to the user.

Parameters

stdClass	$submission	The users own submission record.
stdClass	$teamsubmission	The users team submission record if there is one
int	$userid	The user

Return values

bool

submission_empty()

assign::submission_empty

(

$submission

)

Determine if the current submission is empty or not.

Parameters

submission

$submission

the students submission record to check.

Return values

bool

submissions_open()

assign::submissions_open	(		$userid = 0,
			$skipenrolled = false,
			$submission = false,
			$flags = false,
			$gradinginfo = false
	)

Is this assignment open for submissions?

Check the due date, prevent late submissions, has this person already submitted, is the assignment locked?

Parameters

int	$userid	- Optional userid so we can see if a different user can submit
bool	$skipenrolled	- Skip enrollment checks (because they have been done already)
stdClass	$submission	- Pre-fetched submission record (or false to fetch it)
stdClass	$flags	- Pre-fetched user flags record (or false to fetch it)
stdClass	$gradinginfo	- Pre-fetched user gradinginfo record (or false to fetch it)

Return values

bool

submit_for_grading()

assign::submit_for_grading	(		$data,
			$notices
	)

Submit a submission for grading.

Parameters

stdClass	$data	- The form data
array	$notices	- List of error messages to display on an error condition.

Return values

bool	Return false if the submission was not submitted.

unlock_submission()

assign::unlock_submission

(

$userid

)

Unlock the student submission.

Parameters

int

$userid

Return values

bool

update_activity_completion_records()

assign::update_activity_completion_records (   $teamsubmission,   $requireallteammemberssubmit,   $submission,   $userid,   $complete,   $completion  )

protected

Updates and creates the completion records in mdl_course_modules_completion.

Parameters

int	$teamsubmission	value of 0 or 1 to indicate whether this is a group activity
int	$requireallteammemberssubmit	value of 0 or 1 to indicate whether all group members must click Submit
obj	$submission	the submission
int	$userid	the user id
int	$complete
obj	$completion

Return values

null

update_calendar()

assign::update_calendar

(

$coursemoduleid

)

Update the calendar entries for this assignment.

Parameters

int

$coursemoduleid

- Required to pass this in because it might not exist in the database yet.

Return values

bool

update_effective_access()

assign::update_effective_access

(

$userid

)

Updates the assign properties with override information for a user.

Algorithm: For each assign setting, if there is a matching user-specific override, then use that otherwise, if there are group-specific overrides, return the most lenient combination of them. If neither applies, leave the assign setting unchanged.

Parameters

int

$userid

The userid.

update_grade()

assign::update_grade	(		$grade,
			$reopenattempt = false
	)

Update a grade in the grade table for the assignment and in the gradebook.

Parameters

stdClass	$grade	a grade record keyed on id
bool	$reopenattempt	If the attempt reopen method is manual, allow another attempt at this assignment.

Return values

bool	true for success

update_gradebook()

assign::update_gradebook	(		$reset,
			$coursemoduleid
	)

Update the gradebook information for this assignment.

Parameters

bool	$reset	If true, will reset all grades in the gradbook for this assignment
int	$coursemoduleid	This is required because it might not exist in the database yet

Return values

bool

update_instance()

assign::update_instance

(

$formdata

)

Update this instance in the database.

Parameters

stdClass

$formdata

- the data submitted from the form

Return values

bool	false if an error occurs

update_plugin_instance()

assign::update_plugin_instance ( assign_plugin  $plugin, stdClass  $formdata  )

protected

Update the settings for a single plugin.

Parameters

assign_plugin	$plugin	The plugin to update
stdClass	$formdata	The form data

Return values

bool	false if an error occurs

update_submission()

assign::update_submission ( stdClass  $submission,   $userid,   $updatetime,   $teamsubmission  )

protected

Update grades in the gradebook based on submission time.

Parameters

stdClass	$submission
int	$userid
bool	$updatetime
bool	$teamsubmission

Return values

bool

update_team_submission()

assign::update_team_submission ( stdClass  $submission,   $userid,   $updatetime  )

protected

Update team submission.

Parameters

stdClass	$submission
int	$userid
bool	$updatetime

Return values

bool

update_user_flags()

assign::update_user_flags

(

$flags

)

Update user flags for this user in this assignment.

Parameters

stdClass

$flags

a flags record keyed on id

Return values

bool	true for success

view()

assign::view	(		$action = '',
			$args = array()
	)

Display the assignment, used by view.php.

The assignment is displayed differently depending on your role, the settings for the assignment and the status of the assignment.

Parameters

string	$action	The current action if any.
array	$args	Optional arguments to pass to the view (instead of getting them from GET and POST).

Return values

string

- The page output.

view_batch_markingallocation()

assign::view_batch_markingallocation

(

$mform

)

Shows a form that allows the allocated marker for selected submissions to be changed.

Parameters

moodleform

$mform

Set to a grading batch operations form

Return values

string

- the page to view after processing these actions

view_batch_set_workflow_state()

assign::view_batch_set_workflow_state (   $mform )

protected

Shows a form that allows the workflow state for selected submissions to be changed.

Parameters

moodleform

$mform

Set to a grading batch operations form

Return values

string

- the page to view after processing these actions

view_edit_submission_page()

assign::view_edit_submission_page (   $mform,   $notices  )

protected

View edit submissions page.

Parameters

moodleform	$mform
array	$notices	A list of notices to display at the top of the edit submission form (e.g. from plugins).

Return values

string

The page output.

view_fix_rescaled_null_grades()

assign::view_fix_rescaled_null_grades ( )

protected

View fix rescaled null grades.

Return values

void	The notifications API will render the notifications at the appropriate part of the page.

view_footer()

assign::view_footer ( )

protected

Display the page footer.

Return values

string

view_grader()

assign::view_grader ( )

protected

View entire grader app.

Return values

string

view_grading_page()

assign::view_grading_page ( )

protected

View entire grading page.

Return values

string

view_grading_table()

assign::view_grading_table ( )

protected

View the grading table of all submissions for this assignment.

Return values

string

view_grant_extension()

assign::view_grant_extension (   $mform )

protected

View the grant extension date page.

Uses url parameters 'userid' or from parameter 'selectedusers'

Parameters

moodleform

$mform

- Used for validation of the submitted data

Return values

string

view_notices()

assign::view_notices (   $title,   $notices  )

protected

Message for students when assignment submissions have been closed.

Parameters

string	$title	The page title
array	$notices	The array of notices to show.

Return values

string

view_plugin_content()

assign::view_plugin_content (   $pluginsubtype )

protected

Display the submission that is used by a plugin.

Uses url parameters 'sid', 'gid' and 'plugin'.

Parameters

string

$pluginsubtype

Return values

string

view_plugin_grading_batch_operation()

assign::view_plugin_grading_batch_operation (   $mform )

protected

Allows the plugin to show a batch grading operation page.

Parameters

moodleform

$mform

Return values

none

view_plugin_page()

assign::view_plugin_page ( )

protected

View a page rendered by a plugin.

Uses url parameters 'pluginaction', 'pluginsubtype', 'plugin', and 'id'.

Return values

string

view_quickgrading_result()

assign::view_quickgrading_result (   $message )

protected

Display a continue page after quickgrading.

Parameters

string

$message

- The message to display.

Return values

string

view_remove_submission_confirm()

assign::view_remove_submission_confirm ( )

protected

Show a confirmation page to make sure they want to remove submission data.

Return values

string

view_return_links()

assign::view_return_links ( )

protected

View a link to go back to the previous page.

Uses url parameters returnaction and returnparams.

Return values

string

view_reveal_identities_confirm()

assign::view_reveal_identities_confirm ( )

protected

Show a confirmation page to make sure they want to release student identities.

Return values

string

view_savegrading_result()

assign::view_savegrading_result (   $message )

protected

Display a continue page after grading.

Parameters

string

$message

- The message to display.

Return values

string

view_single_grade_page()

assign::view_single_grade_page (   $mform )

protected

Print the grading page for a single user submission.

Parameters

moodleform

$mform

Return values

string

view_single_grading_panel()

assign::view_single_grading_panel (   $args )

protected

Print the grading page for a single user submission.

Parameters

array

$args

Optional args array (better than pulling args from _GET and _POST)

Return values

string

view_student_summary()

assign::view_student_summary	(		$user,
			$showlinks
	)

Print 2 tables of information with no action links - the submission summary and the grading summary.

Parameters

stdClass	$user	the user to print the report for
bool	$showlinks	- Return plain text or links to the profile

Return values

string

- the html summary

view_submission_page()

assign::view_submission_page ( )

protected

View submissions page (contains details of current submission).

Return values

string

---

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

• mod/assign/locallib.php