enrol_meta

Files
file	access.php
	Capabilities for meta link access plugin.
file	enrol_meta_sync.php
	Meta sync enrolments task.
file	events.php
	Meta course enrolment plugin event handler definition.
file	install.php
	Meta link enrolment plugin installation.
file	lib.php
	Meta course enrolment plugin.
file	locallib.php
	Local stuff for meta course enrolment plugin.
file	observer.php
	Event observer for meta enrolment plugin.
file	provider.php
	Privacy Subsystem implementation for enrol_meta.
file	settings.php
	Meta enrolment plugin settings and presets.
file	tasks.php
	Task definition for enrol_meta.
file	uninstall.php
	Meta link enrolment plugin uninstallation.
file	version.php
	Meta link enrolment plugin version specification.

Namespaces
	enrol_meta\privacy
	enrol_meta\task

Classes
class	enrol_meta\privacy\provider
	Privacy provider for enrol_meta. More...
class	enrol_meta\task\enrol_meta_sync
	Meta sync enrolments task. More...
class	enrol_meta_handler
	Event handler for meta enrolment plugin. More...
class	enrol_meta_observer
	Event observer for enrol_meta. More...
class	enrol_meta_plugin
	Meta course enrolment plugin. More...

Functions
	enrol_meta_create_new_group ($courseid, $linkedcourseid)
	Create a new group with the course's name. More...
	enrol_meta_sync ($courseid=NULL, $verbose=false)
	Sync all meta course links. More...
	xmldb_enrol_meta_install ()
	xmldb_enrol_meta_uninstall ()

Variables
	$capabilities
	$observers
	$tasks
$plugin	component = 'enrol_meta'
const	ENROL_META_CREATE_GROUP -1
	ENROL_META_CREATE_GROUP constant for automatically creating a group for a meta course.
$plugin	requires = 2019111200
$plugin	version = 2019111800

Detailed Description

Function Documentation

enrol_meta_create_new_group()

enrol_meta_create_new_group	(		$courseid,
			$linkedcourseid
	)

Create a new group with the course's name.

Parameters

int	$courseid
int	$linkedcourseid

Return values

int::$groupid

Group ID for this cohort.

enrol_meta_sync()

enrol_meta_sync	(		$courseid = NULL,
			$verbose = false
	)

Sync all meta course links.

Parameters

int	$courseid	one course, empty mean all
bool	$verbose	verbose CLI output

Return values

int	0 means ok, 1 means error, 2 means plugin disabled

Variable Documentation

$capabilities

$capabilities

Initial value:

= array(
    'enrol/meta:config' => array(
        'captype' => 'write',
        'contextlevel' => CONTEXT_COURSE,
        'archetypes' => array(
            'manager' => CAP_ALLOW,
            'editingteacher' => CAP_ALLOW,
        )
    ),
 
    
    'enrol/meta:selectaslinked' => array(
        'captype' => 'read',
        'contextlevel' => CONTEXT_COURSE,
        'archetypes' => array(
            'manager' => CAP_ALLOW,
        )
    ),
 
    
    'enrol/meta:unenrol' => array(
 
        'captype' => 'write',
        'contextlevel' => CONTEXT_COURSE,
        'archetypes' => array(
            'manager' => CAP_ALLOW,
        )
    ),
)

$tasks

$tasks

Initial value:

= array(
    array(
        'classname' => '\enrol_meta\task\enrol_meta_sync',
        'blocking' => 0,
        'minute' => 'R',
        'hour' => '*',
        'day' => '*',
        'month' => '*',
        'dayofweek' => '*',
        'disabled' => 0
    )
)