enrol_category

Topics
	event

Namespaces
namespace	enrol_category\privacy
	Privacy Subsystem implementation for enrol_category.
namespace	enrol_category\task
	Syncing enrolments task.

Classes
class	enrol_category\privacy\provider
	Privacy Subsystem for enrol_category implementing null_provider. More...
class	enrol_category\task\enrol_category_sync
	Syncing enrolments task. More...
class	enrol_category_observer
	Event handler for category enrolment plugin. More...
class	enrol_category_plugin
	category enrolment plugin implementation. More...

Functions
	enrol_category_sync_course ($course)
	Sync all category enrolments in one course.
	enrol_category_sync_full (progress_trace $trace)
	Synchronise courses in all categories.
	xmldb_enrol_category_install ()

Variables
	$capabilities
	$plugin = 2023100400
	$tasks
$plugin	component = 'enrol_category'
$plugin	version = 2023100900

Detailed Description

Function Documentation

enrol_category_sync_course()

enrol_category_sync_course

(

$course

)

Sync all category enrolments in one course.

Parameters

stdClass

$course

Return values

void

enrol_category_sync_full()

enrol_category_sync_full

(

progress_trace

$trace

)

Synchronise courses in all categories.

It gets out-of-sync if:

• you move course to different category
• reorder categories
• disable enrol_category and enable it again

Parameters

progress_trace

$trace

Return values

int	exit code - 0 is ok, 1 means error, 2 if plugin disabled

Variable Documentation

$capabilities

$capabilities

Initial value:

= array(
    
    
    
    'enrol/category:synchronised' => array(
        'captype' => 'write',
        'contextlevel' => CONTEXT_SYSTEM,
        'archetypes' => array(
        )
    ),
    'enrol/category:config' => array(
        'captype' => 'write',
        'contextlevel' => CONTEXT_COURSE,
        'archetypes' => array(
            'manager' => CAP_ALLOW,
            'editingteacher' => CAP_ALLOW,
        )
    ),
)

$tasks

$tasks

Initial value:

= array(
    array(
        'classname' => '\enrol_category\task\enrol_category_sync',
        'blocking' => 0,
        'minute' => '*',
        'hour' => '*',
        'day' => '*',
        'month' => '*',
        'dayofweek' => '*',
        'disabled' => 0
    )
)