Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
enrol_self

Namespaces

namespace  enrol_self\privacy
  
 
namespace  enrol_self\task
  
 

Classes

class  enrol_self\privacy\provider
 Privacy Subsystem for enrol_self implementing null_provider. More...
 
class  enrol_self\task\send_expiry_notifications
 Send expiry notifications task. More...
 
class  enrol_self\task\sync_enrolments
 Sync enrolments task. More...
 
class  enrol_self_deleteselectedusers_form
 The form to confirm the intention to bulk delete users enrolments. More...
 
class  enrol_self_deleteselectedusers_operation
 A bulk operation for the self enrolment plugin to delete selected users enrolments. More...
 
class  enrol_self_editselectedusers_form
 The form to collect required information when bulk editing users enrolments. More...
 
class  enrol_self_editselectedusers_operation
 A bulk operation for the manual enrolment plugin to edit selected users. More...
 
class  enrol_self_empty_form
 
class  enrol_self_enrol_form
 
class  enrol_self_external
 
class  enrol_self_plugin
 Self enrolment plugin implementation. More...
 

Functions

 enrol_self_check_group_enrolment_key ($courseid, $enrolpassword)
 Check if the given password match a group enrolment key in the specified course.
 
 enrol_self_get_fontawesome_icon_map ()
 Get icon mapping for font-awesome.
 
 xmldb_enrol_self_install ()
 
 xmldb_enrol_self_upgrade ($oldversion)
 

Variables

 $capabilities
 
 $functions
 
 $messageproviders
 
 $plugin = 2023100400
 
 $tasks
 
$plugin component = 'enrol_self'
 
$plugin version = 2023100900
 

Detailed Description

Function Documentation

◆ enrol_self_check_group_enrolment_key()

enrol_self_check_group_enrolment_key ( $courseid,
$enrolpassword )

Check if the given password match a group enrolment key in the specified course.

Parameters
int$courseidcourse id
string$enrolpasswordenrolment password
Return values
boolTrue if match
Since
Moodle 3.0

Variable Documentation

◆ $functions

$functions
Initial value:
= array(
'enrol_self_get_instance_info' => array(
'classname' => 'enrol_self_external',
'methodname' => 'get_instance_info',
'classpath' => 'enrol/self/externallib.php',
'description' => 'self enrolment instance information.',
'type' => 'read',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
),
'enrol_self_enrol_user' => array(
'classname' => 'enrol_self_external',
'methodname' => 'enrol_user',
'classpath' => 'enrol/self/externallib.php',
'description' => 'Self enrol the current user in the given course.',
'type' => 'write',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
)
)
const MOODLE_OFFICIAL_MOBILE_SERVICE
Moodle mobile app service name.
Definition moodlelib.php:535

◆ $messageproviders

$messageproviders
Initial value:
= array (
'expiry_notification' => array(),
)

◆ $tasks

$tasks
Initial value:
= array(
array(
'classname' => '\enrol_self\task\sync_enrolments',
'blocking' => 0,
'minute' => '*/10',
'hour' => '*',
'day' => '*',
'month' => '*',
'dayofweek' => '*',
'disabled' => 0
),
array(
'classname' => '\enrol_self\task\send_expiry_notifications',
'blocking' => 0,
'minute' => '*/10',
'hour' => '*',
'day' => '*',
'month' => '*',
'dayofweek' => '*',
'disabled' => 0
)
)