enrol_manual

Files
file	access.php
	Capabilities for manual enrolment plugin.
file	bulkchangeforms.php
	This file contains form for bulk changing user enrolments.
file	enrol_users_form.php
	Enrol users form.
file	externallib.php
	External course participation api.
file	install.php
	Manual enrol plugin installation script.
file	lib.php
	Manual enrolment plugin main library file.
file	locallib.php
	Auxiliary manual user enrolment lib, the main purpose is to lower memory requirements...
file	messages.php
	Defines message providers for manual enrolments.
file	provider.php
	Privacy Subsystem implementation for enrol_manual.
file	send_expiry_notifications.php
	The send expiry notifications task.
file	services.php
	Manual plugin external functions and service definitions.
file	settings.php
	Manual enrolment plugin settings and presets.
file	sync_enrolments.php
	Syncing enrolments task.
file	tasks.php
	Task definition for enrol_manual.
file	upgrade.php
	This file keeps track of upgrades to the manual enrolment plugin.
file	version.php
	Manual enrolment plugin version specification.

Namespaces
	enrol_manual\privacy
	enrol_manual\task

Classes
class	enrol_manual\privacy\provider
	Privacy Subsystem for enrol_manual implementing null_provider. More...
class	enrol_manual\task\send_expiry_notifications
	The send expiry notifications task. More...
class	enrol_manual\task\sync_enrolments
	Syncing enrolments task. More...
class	enrol_manual_current_participant
	Enrolled users. More...
class	enrol_manual_deleteselectedusers_form
	The form to confirm the intention to bulk delete users enrolments. More...
class	enrol_manual_deleteselectedusers_operation
	A bulk operation for the manual enrolment plugin to delete selected users enrolments. More...
class	enrol_manual_editselectedusers_form
	The form to collect required information when bulk editing users enrolments. More...
class	enrol_manual_editselectedusers_operation
	A bulk operation for the manual enrolment plugin to edit selected users. More...
class	enrol_manual_enrol_users_form
class	enrol_manual_external
class	enrol_manual_plugin
class	enrol_manual_potential_participant
	Enrol candidates. More...

Functions
	enrol_manual_get_potential_cohorts ($context, $enrolid, $search='', $page=0, $perpage=25, $addedenrollment=0)
	Gets an array of the cohorts that can be enrolled in this course. More...
	enrol_manual_migrate_plugin_enrolments ($enrol)
	Migrates all enrolments of the given plugin to enrol_manual plugin, this is used for example during plugin uninstallation. More...
	enrol_manual_output_fragment_enrol_users_form ($args)
	Serve the manual enrol users form as a fragment. More...
	xmldb_enrol_manual_install ()
	xmldb_enrol_manual_upgrade ($oldversion)

Variables
	$capabilities
	$functions
	$messageproviders
	$tasks
$plugin	component = 'enrol_manual'
$plugin	requires = 2019111200
$plugin	version = 2019111800

Detailed Description

Function Documentation

enrol_manual_get_potential_cohorts()

enrol_manual_get_potential_cohorts	(		$context,
			$enrolid,
			$search = '',
			$page = 0,
			$perpage = 25,
			$addedenrollment = 0
	)

Gets an array of the cohorts that can be enrolled in this course.

Parameters

int	$enrolid
string	$search
int	$page	Defaults to 0
int	$perpage	Defaults to 25
int	$addedenrollment

Return values

array

Array(totalcohorts => int, cohorts => array)

enrol_manual_migrate_plugin_enrolments()

enrol_manual_migrate_plugin_enrolments

(

$enrol

)

Migrates all enrolments of the given plugin to enrol_manual plugin, this is used for example during plugin uninstallation.

NOTE: this function does not trigger role and enrolment related events.

Parameters

string

$enrol

The enrolment method.

enrol_manual_output_fragment_enrol_users_form()

enrol_manual_output_fragment_enrol_users_form

(

$args

)

Serve the manual enrol users form as a fragment.

Parameters

array

$args

List of named arguments for the fragment loader.

Return values

string

Variable Documentation

$functions

$functions

Initial value:

= array(
 
    
    'enrol_manual_enrol_users' => array(
        'classname'   => 'enrol_manual_external',
        'methodname'  => 'enrol_users',
        'classpath'   => 'enrol/manual/externallib.php',
        'description' => 'Manual enrol users',
        'capabilities'=> 'enrol/manual:enrol',
        'type'        => 'write',
    ),
 
    'enrol_manual_unenrol_users' => array(
        'classname'   => 'enrol_manual_external',
        'methodname'  => 'unenrol_users',
        'classpath'   => 'enrol/manual/externallib.php',
        'description' => 'Manual unenrol users',
        'capabilities'=> 'enrol/manual:unenrol',
        'type'        => 'write',
    ),
 
)

$messageproviders

$messageproviders

Initial value:

= array (
 
    'expiry_notification' => array(),
 
)

$tasks

$tasks

Initial value:

= array(
    array(
        'classname' => '\enrol_manual\task\sync_enrolments',
        'blocking' => 0,
        'minute' => '*/10',
        'hour' => '*',
        'day' => '*',
        'month' => '*',
        'dayofweek' => '*',
        'disabled' => 0
    ),
    array(
        'classname' => '\enrol_manual\task\send_expiry_notifications',
        'blocking' => 0,
        'minute' => '*/10',
        'hour' => '*',
        'day' => '*',
        'month' => '*',
        'dayofweek' => '*',
        'disabled' => 0
    )
)