award_criteria_cohort Class Reference

Badge award criteria – award on cohort membership. More...

Inheritance diagram for award_criteria_cohort:

Public Member Functions
	config_form_criteria ($data)
	Add appropriate criteria elements.
	config_options (&$mform, $param)
	Add appropriate parameter elements to the criteria form.
	delete ()
	Delete this criterion.
	get_completed_criteria_sql ()
	Returns array with sql code and parameters returning all ids of users who meet this particular criterion.
	get_details ($short='')
	Get criteria details for displaying to users.
	get_options (&$mform)
	Add appropriate new criteria options to the form.
	get_params ($cid)
	Return criteria parameters.
	get_title ()
	Return criteria title.
	make_clone ($newbadgeid)
	Saves intial criteria records with required parameters set up.
	mark_complete ($userid)
	Mark this criteria as complete for a user.
	review ($userid, $filtered=false)
	Review this criteria and decide if it has been completed.
	save ($params=array())
	Save criteria records.
	validate ()
	Checks criteria for any major problems.

Static Public Member Functions
static	build ($params)
	Factory method for creating criteria class object.
static	is_enabled ()
	Allow some specific criteria types to be disabled based on config.

Public Attributes
integer	$badgeid
	ID of a badge this criterion belongs to.
int	$criteriatype = BADGE_CRITERIA_TYPE_COHORT
string	$description
	Criterion HTML/plain text description.
integer	$descriptionformat
	Format of the criterion description.
integer	$id
	ID of the criterion.
integer	$method
	Aggregation method [BADGE_CRITERIA_AGGREGATION_ANY, BADGE_CRITERIA_AGGREGATION_ALL].
array	$optional_params = array()
array	$params = array()
	Any additional parameters.
string	$required_param = 'cohort'

Detailed Description

Badge award criteria – award on cohort membership.

@subpackage badges

Copyright

2016 onwards Catalyst IT

License

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

Author

Eugene Venter eugen.nosp@m.e@ca.nosp@m.talys.nosp@m.t.ne.nosp@m.t.nz

Member Function Documentation

build()

static award_criteria::build ( $params )

staticinherited

Factory method for creating criteria class object.

Parameters

array

$params

associative arrays varname => value

Return values

award_criteria

config_form_criteria()

award_criteria::config_form_criteria ( $data )

inherited

Add appropriate criteria elements.

Parameters

stdClass

$data

details of various criteria

Reimplemented in award_criteria_course, and award_criteria_overall.

config_options()

award_criteria::config_options ( & $mform, $param )

inherited

Add appropriate parameter elements to the criteria form.

Reimplemented in award_criteria_overall.

delete()

award_criteria::delete ( )

inherited

Delete this criterion.

Reimplemented in award_criteria_manual.

get_completed_criteria_sql()

award_criteria_cohort::get_completed_criteria_sql

(

)

Returns array with sql code and parameters returning all ids of users who meet this particular criterion.

Return values

array

list($join, $where, $params)

Reimplemented from award_criteria.

get_details()

award_criteria_cohort::get_details

(

$short = ''

)

Get criteria details for displaying to users.

Parameters

string

$short

Print short version of criteria

Return values

string

Reimplemented from award_criteria.

get_options()

award_criteria_cohort::get_options

(

&

$mform

)

Add appropriate new criteria options to the form.

Parameters

object

$mform

moodle form

Reimplemented from award_criteria.

get_params()

award_criteria::get_params ( $cid )

inherited

Return criteria parameters.

Parameters

int

$critid

Criterion ID

Return values

array

Reimplemented in award_criteria_overall.

get_title()

award_criteria::get_title ( )

inherited

Return criteria title.

Return values

string

is_enabled()

static award_criteria::is_enabled ( )

staticinherited

Allow some specific criteria types to be disabled based on config.

Return values

boolean

Reimplemented in award_criteria_competency.

mark_complete()

award_criteria::mark_complete ( $userid )

inherited

Mark this criteria as complete for a user.

Parameters

int

$userid

User whose criteria is completed.

review()

award_criteria_cohort::review	(		$userid,
			$filtered = false )

Review this criteria and decide if it has been completed.

Parameters

int	$userid	User whose criteria completion needs to be reviewed.
bool	$filtered	An additional parameter indicating that user list has been reduced and some expensive checks can be skipped.

Return values

bool	Whether criteria is complete.

Reimplemented from award_criteria.

save()

award_criteria_cohort::save

(

$params = array()

)

Save criteria records.

Parameters

array

$params

Values from the form or any other array.

Reimplemented from award_criteria.

validate()

award_criteria_cohort::validate

(

)

Checks criteria for any major problems.

Return values

array

A list containing status and an error message (if any).

---

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

• badges/criteria/award_criteria_cohort.php