Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_completion\activity_custom_completion Class Reference
Inheritance diagram for core_completion\activity_custom_completion:
mod_assign\completion\custom_completion mod_bigbluebuttonbn\completion\custom_completion mod_choice\completion\custom_completion mod_data\completion\custom_completion mod_feedback\completion\custom_completion mod_folder\completion\custom_completion mod_forum\completion\custom_completion mod_glossary\completion\custom_completion mod_label\completion\custom_completion mod_lesson\completion\custom_completion mod_quiz\completion\custom_completion mod_resource\completion\custom_completion mod_scorm\completion\custom_completion mod_survey\completion\custom_completion mod_url\completion\custom_completion

Public Member Functions

 __construct (cm_info $cm, int $userid, ?array $completionstate=null)
 activity_custom_completion constructor.
 
 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.
 

Constructor & Destructor Documentation

◆ __construct()

core_completion\activity_custom_completion::__construct ( cm_info $cm,
int $userid,
?array $completionstate = null )

activity_custom_completion constructor.

Parameters
cm_info$cm
int$userid
array | null$completionstateThe current state of the core completion criteria

Member Function Documentation

◆ get_available_custom_rules()

core_completion\activity_custom_completion::get_available_custom_rules ( )

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)
static

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

Parameters
string$modnameThe 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)

Fetches the description for a given custom completion rule.

Parameters
string$ruleThe custom completion rule.
Return values
string

◆ get_custom_rule_descriptions()

◆ get_defined_custom_rules()

◆ get_overall_completion_state()

core_completion\activity_custom_completion::get_overall_completion_state ( )

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

Return values
intThe completion state (e.g. COMPLETION_COMPLETE, COMPLETION_INCOMPLETE).

◆ get_sort_order()

◆ get_state()

◆ is_available()

core_completion\activity_custom_completion::is_available ( string $rule)

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

Parameters
string$ruleThe custom completion rule.
Return values
bool

◆ is_defined()

core_completion\activity_custom_completion::is_defined ( string $rule)

Whether this module defines this custom rule.

Parameters
string$ruleThe custom completion rule.
Return values
bool

◆ manual_completion_always_shown()

core_completion\activity_custom_completion::manual_completion_always_shown ( )

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

Returns false by default for plugins that don't need to override the course's showcompletionconditions setting. Activity plugins that need to always show manual completion need to override this function.

Return values
bool

Reimplemented in mod_folder\completion\custom_completion, mod_label\completion\custom_completion, mod_resource\completion\custom_completion, and mod_url\completion\custom_completion.

◆ validate_rule()

core_completion\activity_custom_completion::validate_rule ( string $rule)

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

Parameters
string$ruleThe custom completion rule.

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