enrol_manual

Namespaces
namespace	enrol_manual
namespace	enrol_manual\privacy
namespace	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\user_enrolment_callbacks
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.
	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.
	enrol_manual_output_fragment_enrol_users_form ($args)
	Serve the manual enrol users form as a fragment.
	xmldb_enrol_manual_install ()
	xmldb_enrol_manual_upgrade ($oldversion)

Variables
	$callbacks
	$capabilities
	$functions
	$messageproviders
	$plugin = 2024100100
	$tasks
$plugin	component = 'enrol_manual'
$plugin	version = 2024100700

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

$callbacks

$callbacks

Initial value:

= [
    [
        'hook' => core_enrol\hook\after_user_enrolled::class,
        'callback' => 'enrol_manual\user_enrolment_callbacks::send_course_welcome_message',
    ],
]

$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',
    ),
 
)

Copyright

2011 Jerome Mouneyrac

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

$messageproviders

$messageproviders

Initial value:

= array (
 
    'expiry_notification' => [
        'defaults' => [
            'popup' => MESSAGE_PERMITTED + MESSAGE_DEFAULT_ENABLED,
            'email' => MESSAGE_PERMITTED + MESSAGE_DEFAULT_ENABLED,
        ],
    ],
 
)

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