mod_bigbluebuttonbn\local\extension\custom_completion_addons Class Reference

Public Member Functions
	__construct (cm_info $cm, int $userid, ?array $completionstate=null)
	activity_custom_completion constructor.
	get_custom_rule_descriptions ()
	Returns an associative array of the descriptions of 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.

Static Public Member Functions
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.

Constructor & Destructor Documentation

__construct()

mod_bigbluebuttonbn\local\extension\custom_completion_addons::__construct	(	cm_info	$cm,
		int	$userid,
		?array	$completionstate = null )

activity_custom_completion constructor.

Parameters

cm_info	$cm
int	$userid
array | null	$completionstate	The current state of the core completion criteria

Member Function Documentation

get_custom_rule_descriptions()

mod_bigbluebuttonbn\local\extension\custom_completion_addons::get_custom_rule_descriptions ( )

abstract

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

Return values

array

get_defined_custom_rules()

static mod_bigbluebuttonbn\local\extension\custom_completion_addons::get_defined_custom_rules ( )

staticabstract

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

Return values

array

get_sort_order()

mod_bigbluebuttonbn\local\extension\custom_completion_addons::get_sort_order ( )

abstract

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

Return values

array

get_state()

mod_bigbluebuttonbn\local\extension\custom_completion_addons::get_state ( string $rule )

abstract

Fetches the completion state for a given completion rule.

Parameters

string

$rule

The completion rule.

Return values

int	The completion state.

---

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

• mod/bigbluebuttonbn/classes/local/extension/custom_completion_addons.php