completion_criteria_completion Class Reference

Inheritance diagram for completion_criteria_completion:

Collaboration diagram for completion_criteria_completion:

Public Member Functions
	is_complete ()
	mark_complete ()
	attach_criteria (completion_criteria $criteria)
	get_criteria ()
	get_status ()
Static Public Member Functions
static	fetch ($params)
static	fetch_all ($params)
Data Fields
	$table = 'course_completion_crit_compl'
	$required_fields = array('id', 'userid', 'course', 'criteriaid', 'gradefinal', 'rpl', 'deleted', 'unenroled', 'timecompleted')
	$userid
	$course
	$criteriaid
	$gradefinal
	$rpl
	$deleted
	$unenroled
	$timecompleted

---

Detailed Description

Completion data for a specific user, course and critieria

Definition at line 32 of file completion_criteria_completion.php.

---

Member Function Documentation

attach_criteria

(

completion_criteria $

criteria

)

Attach a preloaded criteria object to this object public

Parameters:

$criteria

object completion_criteria

Returns:

void

Definition at line 173 of file completion_criteria_completion.php.

Here is the caller graph for this function:

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 117 of file completion_criteria_completion.php.

Here is the call graph for this function:

static fetch_all

(

$

params

)

[static]

Finds and returns all data_object instances based on params. abstract

Parameters:

array

$params

associative arrays varname=>value

Returns:

array array of data_object insatnces or false if none found.

Reimplemented from data_object.

Definition at line 129 of file completion_criteria_completion.php.

get_criteria

(

)

Return the associated criteria with this completion If nothing attached, load from the db public

Returns:

object completion_criteria

Definition at line 183 of file completion_criteria_completion.php.

Here is the call graph for this function:

get_status

(

)

Return criteria status text for display in reports

See also:

completion_criteria::get_status() User interface

Returns:

string

Definition at line 207 of file completion_criteria_completion.php.

is_complete

(

)

Return status of this criteria completion public

Returns:

boolean

Definition at line 136 of file completion_criteria_completion.php.

mark_complete

(

)

Mark this criteria complete for the associated user

This method creates a course_completion_crit_compl record public

Returns:

void

Definition at line 147 of file completion_criteria_completion.php.

Here is the call graph for this function:

---

Field Documentation

$course

Definition at line 58 of file completion_criteria_completion.php.

$criteriaid

Definition at line 65 of file completion_criteria_completion.php.

$deleted

Definition at line 86 of file completion_criteria_completion.php.

$gradefinal

Definition at line 72 of file completion_criteria_completion.php.

array $required_fields = array('id', 'userid', 'course', 'criteriaid', 'gradefinal', 'rpl', 'deleted', 'unenroled', 'timecompleted')

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

Reimplemented from data_object.

Definition at line 44 of file completion_criteria_completion.php.

$rpl

Definition at line 79 of file completion_criteria_completion.php.

string $table = 'course_completion_crit_compl'

DB Table

Reimplemented from data_object.

Definition at line 38 of file completion_criteria_completion.php.

$timecompleted

Definition at line 101 of file completion_criteria_completion.php.

$unenroled

Definition at line 93 of file completion_criteria_completion.php.

$userid

Definition at line 51 of file completion_criteria_completion.php.

---

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

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