completion_completion Class Reference

Inheritance diagram for completion_completion:

Collaboration diagram for completion_completion:

Public Member Functions
	is_complete ()
	mark_enrolled ($timeenrolled=null)
	mark_inprogress ($timestarted=null)
	mark_complete ($timecomplete=null)
Static Public Member Functions
static	fetch ($params)
Data Fields
	$table = 'course_completions'
	$required_fields
	$userid
	$course
	$deleted
	$timenotified
	$timeenrolled
	$timestarted
	$timecompleted
	$reaggregate

---

Detailed Description

Course completion status for a particular user/course

Definition at line 33 of file completion_completion.php.

---

Member Function Documentation

static fetch

(

$

params

)

[static]

Finds and returns a data_object instance based on params. abstract

Parameters:

array

$params

associative arrays varname=>value

Returns:

object data_object instance or false if none found.

Reimplemented from data_object.

Definition at line 116 of file completion_completion.php.

Here is the call graph for this function:

is_complete

(

)

Return status of this completion public

Returns:

boolean

Definition at line 126 of file completion_completion.php.

mark_complete

(

$

timecomplete = null

)

Mark this user complete in this course

This generally happens when the required completion criteria in the course are complete.

public

Parameters:

integer

$timecomplete

Time completed (optional)

Returns:

void

Definition at line 192 of file completion_completion.php.

mark_enrolled

(

$

timeenrolled = null

)

Mark this user as started (or enrolled) in this course

If the user is already marked as started, no change will occur

public

Parameters:

integer

$timeenrolled

Time enrolled (optional)

Returns:

void

Definition at line 139 of file completion_completion.php.

mark_inprogress

(

$

timestarted = null

)

Mark this user as inprogress in this course

If the user is already marked as inprogress, the time will not be changed

public

Parameters:

integer

$timestarted

Time started (optional)

Returns:

void

Definition at line 163 of file completion_completion.php.

---

Field Documentation

$course

Definition at line 60 of file completion_completion.php.

$deleted

Definition at line 67 of file completion_completion.php.

$reaggregate

Definition at line 106 of file completion_completion.php.

array $required_fields

Initial value:

 array('id', 'userid', 'course', 'deleted', 'timenotified',
        'timeenrolled', 'timestarted', 'timecompleted', 'reaggregate')

Array of required table fields, must start with 'id'.

Reimplemented from data_object.

Definition at line 45 of file completion_completion.php.

string $table = 'course_completions'

DB Table

Reimplemented from data_object.

Definition at line 39 of file completion_completion.php.

$timecompleted

Definition at line 99 of file completion_completion.php.

$timeenrolled

Definition at line 83 of file completion_completion.php.

$timenotified

Definition at line 75 of file completion_completion.php.

$timestarted

Definition at line 91 of file completion_completion.php.

$userid

Definition at line 53 of file completion_completion.php.

---

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

• C:/xampp/htdocs/moodle/lib/completion/completion_completion.php