mod_resource\completion\custom_completion Class Reference

Inheritance diagram for mod_resource\completion\custom_completion:

Public Member Functions
	get_available_custom_rules ()
	Fetches the list of custom completion rules that are being used by this activity module instance.
	get_custom_rule_description (string $rule)
	Fetches the description for a given custom completion rule.
	get_custom_rule_descriptions ()
	Returns an associative array of the descriptions of custom completion rules.
	get_overall_completion_state ()
	Fetches the overall completion status of this activity instance for a user based on its available custom completion rules.
	get_sort_order ()
	Returns an array of all completion rules, in the order they should be displayed to users.
	get_state (string $rule)
	Fetches the completion state for a given completion rule.
	is_available (string $rule)
	Checks whether the custom completion rule is being used by the activity module instance.
	is_defined (string $rule)
	Whether this module defines this custom rule.
	manual_completion_always_shown ()
	Show the manual completion or not regardless of the course's showcompletionconditions setting.
	validate_rule (string $rule)
	Validates that the custom rule is defined by this plugin and is enabled for this activity instance.

Static Public Member Functions
static	get_cm_completion_class (string $modname)
	Fetches the module's custom completion class implementation if it's available.
static	get_defined_custom_rules ()
	Fetch the list of custom completion rules that this module defines.

Protected Attributes
cm_info	$cm
	The course module information object.
array	$completionstate
	The current state of core completion.
int	$userid
	The user's ID.

Member Function Documentation

get_available_custom_rules()

core_completion\activity_custom_completion::get_available_custom_rules ( )

inherited

Fetches the list of custom completion rules that are being used by this activity module instance.

Return values

array

get_cm_completion_class()

static core_completion\activity_custom_completion::get_cm_completion_class ( string $modname )

staticinherited

Fetches the module's custom completion class implementation if it's available.

Parameters

string

$modname

The activity module name. Usually from cm_info\modname.

Return values

string|null

get_custom_rule_description()

core_completion\activity_custom_completion::get_custom_rule_description ( string $rule )

inherited

Fetches the description for a given custom completion rule.

Parameters

string

$rule

The custom completion rule.

Return values

string

get_custom_rule_descriptions()

mod_resource\completion\custom_completion::get_custom_rule_descriptions

(

)

Returns an associative array of the descriptions of custom completion rules.

Return values

array

Reimplemented from core_completion\activity_custom_completion.

get_defined_custom_rules()

static mod_resource\completion\custom_completion::get_defined_custom_rules ( )

static

Fetch the list of custom completion rules that this module defines.

Return values

array

Reimplemented from core_completion\activity_custom_completion.

get_overall_completion_state()

core_completion\activity_custom_completion::get_overall_completion_state ( )

inherited

Fetches the overall completion status of this activity instance for a user based on its available custom completion rules.

Return values

int	The completion state (e.g. COMPLETION_COMPLETE, COMPLETION_INCOMPLETE, COMPLETION_COMPLETE_FAIL).

get_sort_order()

mod_resource\completion\custom_completion::get_sort_order

(

)

Returns an array of all completion rules, in the order they should be displayed to users.

Return values

array

Reimplemented from core_completion\activity_custom_completion.

get_state()

mod_resource\completion\custom_completion::get_state

(

string

$rule

)

Fetches the completion state for a given completion rule.

Parameters

string

$rule

The completion rule.

Return values

int	The completion state.

Reimplemented from core_completion\activity_custom_completion.

is_available()

core_completion\activity_custom_completion::is_available ( string $rule )

inherited

Checks whether the custom completion rule is being used by the activity module instance.

Parameters

string

$rule

The custom completion rule.

Return values

bool

is_defined()

core_completion\activity_custom_completion::is_defined ( string $rule )

inherited

Whether this module defines this custom rule.

Parameters

string

$rule

The custom completion rule.

Return values

bool

manual_completion_always_shown()

mod_resource\completion\custom_completion::manual_completion_always_shown

(

)

Show the manual completion or not regardless of the course's showcompletionconditions setting.

Return values

bool

Reimplemented from core_completion\activity_custom_completion.

validate_rule()

core_completion\activity_custom_completion::validate_rule ( string $rule )

inherited

Validates that the custom rule is defined by this plugin and is enabled for this activity instance.

Parameters

string

$rule

The custom completion rule.

---

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

• mod/resource/classes/completion/custom_completion.php