completion_criteria Class Reference

Inheritance diagram for completion_criteria:

Collaboration diagram for completion_criteria:

Public Member Functions
	config_form_display (&$mform, $data=null)
	update_config (&$data)
	review ($completion, $mark=true)
	get_title ()
	get_title_detailed ()
	get_type_title ()
	get_details ($completion)
	get_status ($completion)
	is_pending ($completion)
Static Public Member Functions
static	fetch_all ($params)
static	factory ($params)
Data Fields
	$table = 'course_completion_criteria'
	$required_fields = array('id', 'course', 'criteriatype', 'module', 'moduleinstance', 'courseinstance', 'enrolperiod', 'timeend', 'gradepass', 'role')
	$course
	$criteriatype
	$module
	$moduleinstance
	$enrolperiod
	$date
	$gradepass
	$role

---

Detailed Description

Completion criteria abstract definition

Definition at line 64 of file completion_criteria.php.

---

Member Function Documentation

config_form_display	(	&$	mform,
		$	data = null
	)		[abstract]

Add appropriate form elements to the critieria form public

Parameters:

object	$mform	Moodle forms object
mixed	$data	optional

Returns:

void

Reimplemented in completion_criteria_grade, completion_criteria_course, completion_criteria_date, completion_criteria_activity, completion_criteria_duration, completion_criteria_role, completion_criteria_self, and completion_criteria_unenrol.

static factory

(

$

params

)

[static]

Factory method for creating correct class object

Parameters:

array

Returns:

object

Definition at line 141 of file completion_criteria.php.

Here is the caller 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 133 of file completion_criteria.php.

get_details

(

$

completion

)

[abstract]

Return criteria progress details for display in reports public

Parameters:

object

$completion

The user's completion record

Returns:

array

Reimplemented in completion_criteria_duration, completion_criteria_activity, completion_criteria_grade, completion_criteria_course, completion_criteria_date, completion_criteria_role, completion_criteria_self, and completion_criteria_unenrol.

get_status

(

$

completion

)

Return criteria status text for display in reports public

Parameters:

object

$completion

The user's completion record

Returns:

string

Reimplemented in completion_criteria_duration, completion_criteria_grade, and completion_criteria_date.

Definition at line 215 of file completion_criteria.php.

get_title

(

)

[abstract]

Return criteria title for display in reports public

Returns:

string

Reimplemented in completion_criteria_activity, completion_criteria_duration, completion_criteria_grade, completion_criteria_course, completion_criteria_role, completion_criteria_self, completion_criteria_date, and completion_criteria_unenrol.

get_title_detailed

(

)

[abstract]

Return a more detailed criteria title for display in reports public

Returns:

string

Reimplemented in completion_criteria_activity, completion_criteria_duration, completion_criteria_grade, completion_criteria_role, completion_criteria_course, completion_criteria_self, completion_criteria_date, and completion_criteria_unenrol.

get_type_title

(

)

[abstract]

Return criteria type title for display in reports public

Returns:

string

Reimplemented in completion_criteria_activity, completion_criteria_duration, completion_criteria_grade, completion_criteria_course, completion_criteria_role, completion_criteria_self, completion_criteria_date, and completion_criteria_unenrol.

is_pending

(

$

completion

)

Return true if the criteria's current status is different to what is sorted in the database, e.g. pending an update

Parameters:

object

$completion

The user's criteria completion record

Returns:

bool

Definition at line 226 of file completion_criteria.php.

Here is the call graph for this function:

review	(	$	completion,
		$	mark = true
	)		[abstract]

Review this criteria and decide if the user has completed public

Parameters:

object	$completion	The user's completion record
boolean	$mark	Optionally set false to not save changes to database

Returns:

boolean

Reimplemented in completion_criteria_activity, completion_criteria_duration, completion_criteria_grade, completion_criteria_course, completion_criteria_date, and completion_criteria_unenrol.

Here is the caller graph for this function:

update_config

(

&$

data

)

[abstract]

Update the criteria information stored in the database public

Parameters:

array

$data

Form data

Returns:

void

Reimplemented in completion_criteria_duration, completion_criteria_grade, completion_criteria_course, completion_criteria_date, completion_criteria_role, completion_criteria_activity, completion_criteria_self, and completion_criteria_unenrol.

---

Field Documentation

$course

Definition at line 81 of file completion_criteria.php.

$criteriatype

Reimplemented in completion_criteria_grade, completion_criteria_course, completion_criteria_activity, completion_criteria_date, completion_criteria_duration, completion_criteria_role, completion_criteria_self, and completion_criteria_unenrol.

Definition at line 88 of file completion_criteria.php.

$date

Definition at line 112 of file completion_criteria.php.

$enrolperiod

Definition at line 106 of file completion_criteria.php.

$gradepass

Definition at line 118 of file completion_criteria.php.

$module

Definition at line 94 of file completion_criteria.php.

$moduleinstance

Definition at line 100 of file completion_criteria.php.

array $required_fields = array('id', 'course', 'criteriatype', 'module', 'moduleinstance', 'courseinstance', 'enrolperiod', 'timeend', 'gradepass', 'role')

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

Reimplemented from data_object.

Definition at line 75 of file completion_criteria.php.

$role

Definition at line 124 of file completion_criteria.php.

string $table = 'course_completion_criteria'

DB Table

Reimplemented from data_object.

Definition at line 69 of file completion_criteria.php.

---

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

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