Class containing completion API. More...

Static Public Member Functions
static	mark_course_completions_activity_criteria ($userdata=null)
	Mark users who completed course based on activity criteria.

static	update_completion_date_event ($cmid, $modulename, $instanceorid, $completionexpectedtime)
	Creates, updates or deletes an event for the expected completion date.

Public Attributes
string const	COMPLETION_EVENT_TYPE_DATE_COMPLETION_EXPECTED = 'expectcompletionon'
	The completion expected on event.

Detailed Description

Class containing completion API.

Member Function Documentation

static core_completion\api::mark_course_completions_activity_criteria ( $userdata = null )

static

Mark users who completed course based on activity criteria.

Parameters

array $userdata If set only marks specified user in given course else checks all courses/users.

Return values

int	Completion record id if $userdata is set, 0 else.

static core_completion\api::update_completion_date_event	(	$cmid,
		$modulename,
		$instanceorid,
		$completionexpectedtime
	)

static

Creates, updates or deletes an event for the expected completion date.

Parameters

int	$cmid	The course module id
string	$modulename	The name of the module (eg. assign, quiz)
stdClass \| int	$instanceorid	The instance object or ID.
int \| null	$completionexpectedtime	The time completion is expected, null if not set

Return values

bool

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