Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
enrol_plugin Class Reference

Enrolment plugins abstract class. More...

Inheritance diagram for enrol_plugin:
enrol_category_plugin enrol_cohort_plugin enrol_database_plugin enrol_flatfile_plugin enrol_guest_plugin enrol_imsenterprise_plugin enrol_ldap_plugin enrol_lti_plugin enrol_manual_plugin enrol_meta_plugin enrol_mnet_plugin enrol_paypal_plugin enrol_self_plugin

Public Member Functions

 add_course_navigation ($instancesnode, stdClass $instance)
 Adds navigation links into course admin block. More...
 
 add_default_instance ($course)
 Add new instance of enrol plugin with default settings, called when adding new instance manually or when adding new course. More...
 
 add_instance ($course, array $fields=NULL)
 Add new instance of enrol plugin. More...
 
 allow_enrol (stdClass $instance)
 Does this plugin allow manual enrolments? More...
 
 allow_manage (stdClass $instance)
 Does this plugin allow manual changes in user_enrolments table? More...
 
 allow_unenrol (stdClass $instance)
 Does this plugin allow manual unenrolment of all users? All plugins allowing this must implement 'enrol/xxx:unenrol' capability. More...
 
 allow_unenrol_user (stdClass $instance, stdClass $ue)
 Does this plugin allow manual unenrolment of a specific user? All plugins allowing this must implement 'enrol/xxx:unenrol' capability. More...
 
 backup_annotate_custom_fields (backup_enrolments_execution_step $step, stdClass $enrol)
 Backup execution step hook to annotate custom fields. More...
 
 can_add_instance ($courseid)
 Return whether or not, given the current state, it is possible to add a new instance of this enrolment plugin to the course. More...
 
 can_delete_instance ($instance)
 Is it possible to delete enrol instance via standard UI? More...
 
 can_edit_instance ($instance)
 Return whether or not, given the current state, it is possible to edit an instance of this enrolment plugin in the course. More...
 
 can_hide_show_instance ($instance)
 Is it possible to hide/show enrol instance via standard UI? More...
 
 can_self_enrol (stdClass $instance, $checkuserenrolment=true)
 Checks if user can self enrol. More...
 
 course_edit_form ($instance, MoodleQuickForm $mform, $data, $context)
 Adds enrol instance UI to course edit form. More...
 
 course_edit_validation ($instance, array $data, $context)
 Validates course edit form data. More...
 
 course_updated ($inserted, $course, $data)
 Called after updating/inserting course. More...
 
 cron ()
 Called for all enabled enrol plugins that returned true from is_cron_required(). More...
 
 delete_instance ($instance)
 Delete course enrol plugin instance, unenrol all users. More...
 
 edit_instance_form ($instance, MoodleQuickForm $mform, $context)
 Adds form elements to add/edit instance form. More...
 
 edit_instance_validation ($data, $files, $instance, $context)
 Perform custom validation of the data used to edit the instance. More...
 
 enrol_page_hook (stdClass $instance)
 Creates course enrol form, checks if form submitted and enrols user if necessary. More...
 
 enrol_user (stdClass $instance, $userid, $roleid=null, $timestart=0, $timeend=0, $status=null, $recovergrades=null)
 Enrol user into course via enrol instance. More...
 
 get_action_icons (stdClass $instance)
 Returns edit icons for the page with list of instances. More...
 
 get_bulk_operations (course_enrolment_manager $manager)
 Return an array of enrol_bulk_enrolment_operation objects that define the bulk actions that can be performed on user enrolments by the plugin. More...
 
 get_config ($name, $default=NULL)
 Returns plugin config value. More...
 
 get_description_text ($instance)
 Returns optional enrolment instance description text. More...
 
 get_enrol_info (stdClass $instance)
 Return information for enrolment instance containing list of parameters required for enrolment, name of enrolment plugin etc. More...
 
 get_info_icons (array $instances)
 Returns optional enrolment information icons. More...
 
 get_instance_defaults ()
 Returns defaults for new instances. More...
 
 get_instance_name ($instance)
 Returns localised name of enrol instance. More...
 
 get_manual_enrol_button (course_enrolment_manager $manager)
 Returns an enrol_user_button that takes the user to a page where they are able to enrol users into the managers course through this plugin. More...
 
 get_manual_enrol_link ($instance)
 Returns link to manual enrol UI if exists. More...
 
 get_name ()
 Returns name of this enrol plugin. More...
 
 get_newinstance_link ($courseid)
 Returns link to page which may be used to add new instance of enrolment plugin in course. More...
 
 get_unenrolself_link ($instance)
 Returns list of unenrol links for all enrol instances in course. More...
 
 get_user_enrolment_actions (course_enrolment_manager $manager, $ue)
 Gets an array of the user enrolment actions. More...
 
 has_bulk_operations (course_enrolment_manager $manager)
 Returns true if the plugin has one or more bulk operations that can be performed on user enrolments. More...
 
 instance_deleteable ($instance)
 
 is_cron_required ()
 Reads version.php and determines if it is necessary to execute the cron job now. More...
 
 process_expirations (progress_trace $trace, $courseid=null)
 Do any enrolments need expiration processing. More...
 
 restore_group_member ($instance, $groupid, $userid)
 Restore user group membership. More...
 
 restore_instance (restore_enrolments_structure_step $step, stdClass $data, $course, $oldid)
 Restore instance and map settings. More...
 
 restore_role_assignment ($instance, $roleid, $userid, $contextid)
 Restore role assignment. More...
 
 restore_sync_course ($course)
 Automatic enrol sync executed during restore. More...
 
 restore_user_enrolment (restore_enrolments_structure_step $step, $data, $instance, $userid, $oldinstancestatus)
 Restore user enrolment. More...
 
 roles_protected ()
 Does this plugin assign protected roles are can they be manually removed? More...
 
 send_expiry_notifications ($trace)
 Send expiry notifications. More...
 
 set_config ($name, $value)
 Sets plugin config value. More...
 
 show_enrolme_link (stdClass $instance)
 Does this plugin support some way to user to self enrol? More...
 
 sync_user_enrolments ($user)
 Forces synchronisation of user enrolments. More...
 
 try_autoenrol (stdClass $instance)
 Attempt to automatically enrol current user in course without any interaction, calling code has to make sure the plugin and instance are active. More...
 
 try_guestaccess (stdClass $instance)
 Attempt to automatically gain temporary guest access to course, calling code has to make sure the plugin and instance are active. More...
 
 unenrol_user (stdClass $instance, $userid)
 Unenrol user from course, the last unenrolment removes all remaining roles. More...
 
 update_instance ($instance, $data)
 Update instance of enrol plugin. More...
 
 update_status ($instance, $newstatus)
 Update instance status. More...
 
 update_user_enrol (stdClass $instance, $userid, $status=NULL, $timestart=NULL, $timeend=NULL)
 Store user_enrolments changes and trigger event. More...
 
 use_standard_editing_ui ()
 This returns false for backwards compatibility, but it is really recommended. More...
 
 user_delete ($user)
 Called when user is about to be deleted. More...
 
 validate_param_types ($data, $rules)
 Validate a list of parameter names and types. More...
 

Protected Member Functions

 get_enroller ($instanceid)
 Returns the user who is responsible for enrolments for given instance. More...
 
 load_config ()
 Makes sure config is loaded and cached. More...
 
 notify_expiry_enrolled ($user, $ue, progress_trace $trace)
 Notify user about incoming expiration of their enrolment, it is called only if notification of enrolled users (aka students) is enabled in course. More...
 
 notify_expiry_enroller ($eid, $users, progress_trace $trace)
 Notify person responsible for enrolments that some user enrolments will be expired soon, it is called only if notification of enrollers (aka teachers) is enabled in course. More...
 

Protected Attributes

 $config = null
 

Detailed Description

Enrolment plugins abstract class.

All enrol plugins should be based on this class, this is also the main source of documentation.

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

Member Function Documentation

◆ add_course_navigation()

enrol_plugin::add_course_navigation (   $instancesnode,
stdClass  $instance 
)

Adds navigation links into course admin block.

By defaults looks for manage links only.

Parameters
navigation_node$instancesnode
stdClass$instance
Return values
void

◆ add_default_instance()

enrol_plugin::add_default_instance (   $course)

Add new instance of enrol plugin with default settings, called when adding new instance manually or when adding new course.

Not all plugins support this.

Parameters
object$course
Return values
intid of new instance or null if no default supported

Reimplemented in enrol_guest_plugin, enrol_manual_plugin, and enrol_self_plugin.

◆ add_instance()

enrol_plugin::add_instance (   $course,
array  $fields = NULL 
)

Add new instance of enrol plugin.

Parameters
object$course
arrayinstance fields
Return values
intid of new instance, null if can not be created

Reimplemented in enrol_cohort_plugin, enrol_guest_plugin, enrol_lti_plugin, enrol_manual_plugin, enrol_meta_plugin, enrol_paypal_plugin, and enrol_self_plugin.

◆ allow_enrol()

enrol_plugin::allow_enrol ( stdClass  $instance)

Does this plugin allow manual enrolments?

Parameters
stdClass$instancecourse enrol instance All plugins allowing this must implement 'enrol/xxx:enrol' capability
Return values
bool- true means user with 'enrol/xxx:enrol' may enrol others freely, false means nobody may add more enrolments manually

Reimplemented in enrol_manual_plugin.

◆ allow_manage()

enrol_plugin::allow_manage ( stdClass  $instance)

Does this plugin allow manual changes in user_enrolments table?

All plugins allowing this must implement 'enrol/xxx:manage' capability

Parameters
stdClass$instancecourse enrol instance
Return values
bool- true means it is possible to change enrol period and status in user_enrolments table

Reimplemented in enrol_flatfile_plugin, enrol_manual_plugin, enrol_paypal_plugin, and enrol_self_plugin.

◆ allow_unenrol()

enrol_plugin::allow_unenrol ( stdClass  $instance)

Does this plugin allow manual unenrolment of all users? All plugins allowing this must implement 'enrol/xxx:unenrol' capability.

Parameters
stdClass$instancecourse enrol instance
Return values
bool- true means user with 'enrol/xxx:unenrol' may unenrol others freely, false means nobody may touch user_enrolments

Reimplemented in enrol_flatfile_plugin, enrol_lti_plugin, enrol_manual_plugin, enrol_paypal_plugin, and enrol_self_plugin.

◆ allow_unenrol_user()

enrol_plugin::allow_unenrol_user ( stdClass  $instance,
stdClass  $ue 
)

Does this plugin allow manual unenrolment of a specific user? All plugins allowing this must implement 'enrol/xxx:unenrol' capability.

This is useful especially for synchronisation plugins that do suspend instead of full unenrolment.

Parameters
stdClass$instancecourse enrol instance
stdClass$uerecord from user_enrolments table, specifies user
Return values
bool- true means user with 'enrol/xxx:unenrol' may unenrol this user, false means nobody may touch this user enrolment

Reimplemented in enrol_cohort_plugin, enrol_database_plugin, enrol_flatfile_plugin, and enrol_meta_plugin.

◆ backup_annotate_custom_fields()

enrol_plugin::backup_annotate_custom_fields ( backup_enrolments_execution_step  $step,
stdClass  $enrol 
)

Backup execution step hook to annotate custom fields.

Parameters
backup_enrolments_execution_step$step
stdClass$enrol

◆ can_add_instance()

enrol_plugin::can_add_instance (   $courseid)

Return whether or not, given the current state, it is possible to add a new instance of this enrolment plugin to the course.

Default implementation is just for backwards compatibility.

Parameters
int$courseid
Return values
boolean

Reimplemented in enrol_cohort_plugin, enrol_guest_plugin, enrol_lti_plugin, enrol_manual_plugin, enrol_meta_plugin, enrol_mnet_plugin, enrol_paypal_plugin, and enrol_self_plugin.

◆ can_delete_instance()

enrol_plugin::can_delete_instance (   $instance)

Is it possible to delete enrol instance via standard UI?

Parameters
stdClass$instance
Return values
bool

Reimplemented in enrol_category_plugin, enrol_cohort_plugin, enrol_database_plugin, enrol_flatfile_plugin, enrol_guest_plugin, enrol_ldap_plugin, enrol_lti_plugin, enrol_manual_plugin, enrol_meta_plugin, enrol_mnet_plugin, enrol_paypal_plugin, and enrol_self_plugin.

◆ can_edit_instance()

enrol_plugin::can_edit_instance (   $instance)

Return whether or not, given the current state, it is possible to edit an instance of this enrolment plugin in the course.

Used by the standard editing UI to generate a link to the edit instance form if editing is allowed.

Parameters
stdClass$instance
Return values
boolean

◆ can_hide_show_instance()

enrol_plugin::can_hide_show_instance (   $instance)

Is it possible to hide/show enrol instance via standard UI?

Parameters
stdClass$instance
Return values
bool

Reimplemented in enrol_category_plugin, enrol_cohort_plugin, enrol_database_plugin, enrol_flatfile_plugin, enrol_guest_plugin, enrol_ldap_plugin, enrol_lti_plugin, enrol_manual_plugin, enrol_meta_plugin, enrol_mnet_plugin, enrol_paypal_plugin, and enrol_self_plugin.

◆ can_self_enrol()

enrol_plugin::can_self_enrol ( stdClass  $instance,
  $checkuserenrolment = true 
)

Checks if user can self enrol.

Parameters
stdClass$instanceenrolment instance
bool$checkuserenrolmentif true will check if user enrolment is inactive. used by navigation to improve performance.
Return values
bool|stringtrue if successful, else error message or false

Reimplemented in enrol_self_plugin.

◆ course_edit_form()

enrol_plugin::course_edit_form (   $instance,
MoodleQuickForm  $mform,
  $data,
  $context 
)

Adds enrol instance UI to course edit form.

Parameters
object$instanceenrol instance or null if does not exist yet
MoodleQuickForm$mform
object$data
object$contextcontext of existing course or parent category if course does not exist
Return values
void

◆ course_edit_validation()

enrol_plugin::course_edit_validation (   $instance,
array  $data,
  $context 
)

Validates course edit form data.

Parameters
object$instanceenrol instance or null if does not exist yet
array$data
object$contextcontext of existing course or parent category if course does not exist
Return values
arrayerrors array

◆ course_updated()

enrol_plugin::course_updated (   $inserted,
  $course,
  $data 
)

Called after updating/inserting course.

Parameters
bool$insertedtrue if course just inserted
object$course
object$dataform data
Return values
void

Reimplemented in enrol_category_plugin, enrol_cohort_plugin, enrol_guest_plugin, and enrol_meta_plugin.

◆ cron()

enrol_plugin::cron ( )

Called for all enabled enrol plugins that returned true from is_cron_required().

Return values
void

Reimplemented in enrol_imsenterprise_plugin.

◆ delete_instance()

enrol_plugin::delete_instance (   $instance)

Delete course enrol plugin instance, unenrol all users.

Parameters
object$instance
Return values
void

Reimplemented in enrol_lti_plugin.

◆ edit_instance_form()

enrol_plugin::edit_instance_form (   $instance,
MoodleQuickForm  $mform,
  $context 
)

Adds form elements to add/edit instance form.

Since
Moodle 3.1
Parameters
object$instanceenrol instance or null if does not exist yet
MoodleQuickForm$mform
context$context
Return values
void

Reimplemented in enrol_guest_plugin, enrol_lti_plugin, enrol_manual_plugin, enrol_mnet_plugin, enrol_paypal_plugin, enrol_self_plugin, enrol_cohort_plugin, and enrol_meta_plugin.

◆ edit_instance_validation()

enrol_plugin::edit_instance_validation (   $data,
  $files,
  $instance,
  $context 
)

Perform custom validation of the data used to edit the instance.

Since
Moodle 3.1
Parameters
array$dataarray of ("fieldname"=>value) of submitted data
array$filesarray of uploaded files "element_name"=>tmp_file_path
object$instanceThe instance data loaded from the DB.
context$contextThe context of the instance we are editing
Return values
arrayof "element_name"=>"error_description" if there are errors, or an empty array if everything is OK.

Reimplemented in enrol_cohort_plugin, enrol_guest_plugin, enrol_lti_plugin, enrol_manual_plugin, enrol_meta_plugin, enrol_mnet_plugin, enrol_paypal_plugin, and enrol_self_plugin.

◆ enrol_page_hook()

enrol_plugin::enrol_page_hook ( stdClass  $instance)

Creates course enrol form, checks if form submitted and enrols user if necessary.

It can also redirect.

Parameters
stdClass$instance
Return values
stringhtml text, usually a form in a text box

Reimplemented in enrol_guest_plugin, enrol_paypal_plugin, and enrol_self_plugin.

◆ enrol_user()

enrol_plugin::enrol_user ( stdClass  $instance,
  $userid,
  $roleid = null,
  $timestart = 0,
  $timeend = 0,
  $status = null,
  $recovergrades = null 
)

Enrol user into course via enrol instance.

Parameters
stdClass$instance
int$userid
int$roleidoptional role id
int$timestart0 means unknown
int$timeend0 means forever
int$statusdefault to ENROL_USER_ACTIVE for new enrolments, no change by default in updates
bool$recovergradesrestore grade history
Return values
void

Reimplemented in enrol_flatfile_plugin, and enrol_guest_plugin.

◆ get_action_icons()

enrol_plugin::get_action_icons ( stdClass  $instance)

Returns edit icons for the page with list of instances.

Parameters
stdClass$instance
Return values
array

Reimplemented in enrol_manual_plugin.

◆ get_bulk_operations()

enrol_plugin::get_bulk_operations ( course_enrolment_manager  $manager)

Return an array of enrol_bulk_enrolment_operation objects that define the bulk actions that can be performed on user enrolments by the plugin.

Parameters
course_enrolment_manager$manager
Return values
array

Reimplemented in enrol_manual_plugin, and enrol_self_plugin.

◆ get_config()

enrol_plugin::get_config (   $name,
  $default = NULL 
)

Returns plugin config value.

Parameters
string$name
string$defaultvalue if config does not exist yet
Return values
stringvalue or default

◆ get_description_text()

enrol_plugin::get_description_text (   $instance)

Returns optional enrolment instance description text.

This is used in detailed course information.

Parameters
object$instance
Return values
stringshort html text

◆ get_enrol_info()

enrol_plugin::get_enrol_info ( stdClass  $instance)

Return information for enrolment instance containing list of parameters required for enrolment, name of enrolment plugin etc.

Parameters
stdClass$instanceenrolment instance
Return values
arrayinstance info.

Reimplemented in enrol_guest_plugin, and enrol_self_plugin.

◆ get_enroller()

enrol_plugin::get_enroller (   $instanceid)
protected

Returns the user who is responsible for enrolments for given instance.

Override if plugin knows anybody better than admin.

Parameters
int$instanceidenrolment instance id
Return values
stdClassuser record

Reimplemented in enrol_flatfile_plugin, enrol_manual_plugin, and enrol_self_plugin.

◆ get_info_icons()

enrol_plugin::get_info_icons ( array  $instances)

Returns optional enrolment information icons.

This is used in course list for quick overview of enrolment options.

We are not using single instance parameter because sometimes we might want to prevent icon repetition when multiple instances of one type exist. One instance may also produce several icons.

Parameters
array$instancesall enrol instances of this type in one course
Return values
arrayof pix_icon

Reimplemented in enrol_guest_plugin, enrol_paypal_plugin, and enrol_self_plugin.

◆ get_instance_defaults()

enrol_plugin::get_instance_defaults ( )

Returns defaults for new instances.

Since
Moodle 3.1
Return values
array

Reimplemented in enrol_guest_plugin, and enrol_self_plugin.

◆ get_instance_name()

enrol_plugin::get_instance_name (   $instance)

Returns localised name of enrol instance.

Parameters
object$instance(null is accepted too)
Return values
string

Reimplemented in enrol_cohort_plugin, enrol_meta_plugin, enrol_mnet_plugin, and enrol_self_plugin.

◆ get_manual_enrol_button()

enrol_plugin::get_manual_enrol_button ( course_enrolment_manager  $manager)

Returns an enrol_user_button that takes the user to a page where they are able to enrol users into the managers course through this plugin.

Optional: If the plugin supports manual enrolments it can choose to override this otherwise it shouldn't

Parameters
course_enrolment_manager$manager
Return values
enrol_user_button|false

Reimplemented in enrol_manual_plugin.

◆ get_manual_enrol_link()

enrol_plugin::get_manual_enrol_link (   $instance)

Returns link to manual enrol UI if exists.

Does the access control tests automatically.

Parameters
object$instance
Return values
moodle_url

Reimplemented in enrol_manual_plugin.

◆ get_name()

enrol_plugin::get_name ( )

Returns name of this enrol plugin.

Return values
string

◆ get_newinstance_link()

enrol_plugin::get_newinstance_link (   $courseid)

Returns link to page which may be used to add new instance of enrolment plugin in course.

Parameters
int$courseid
Return values
moodle_urlpage url

Reimplemented in enrol_category_plugin.

◆ get_unenrolself_link()

enrol_plugin::get_unenrolself_link (   $instance)

Returns list of unenrol links for all enrol instances in course.

Parameters
int$instance
Return values
moodle_urlor NULL if self unenrolment not supported

◆ get_user_enrolment_actions()

enrol_plugin::get_user_enrolment_actions ( course_enrolment_manager  $manager,
  $ue 
)

Gets an array of the user enrolment actions.

Parameters
course_enrolment_manager$manager
stdClass$ue
Return values
arrayAn array of user_enrolment_actions

◆ has_bulk_operations()

enrol_plugin::has_bulk_operations ( course_enrolment_manager  $manager)

Returns true if the plugin has one or more bulk operations that can be performed on user enrolments.

Parameters
course_enrolment_manager$manager
Return values
bool

◆ instance_deleteable()

enrol_plugin::instance_deleteable (   $instance)
Deprecated:
since Moodle 2.8 MDL-35864 - please use can_delete_instance() instead.

◆ is_cron_required()

enrol_plugin::is_cron_required ( )

Reads version.php and determines if it is necessary to execute the cron job now.

Return values
bool

◆ load_config()

enrol_plugin::load_config ( )
protected

Makes sure config is loaded and cached.

Return values
void

◆ notify_expiry_enrolled()

enrol_plugin::notify_expiry_enrolled (   $user,
  $ue,
progress_trace  $trace 
)
protected

Notify user about incoming expiration of their enrolment, it is called only if notification of enrolled users (aka students) is enabled in course.

This is executed only once for each expiring enrolment right at the start of the expiration threshold.

Parameters
stdClass$user
stdClass$ue
progress_trace$trace

◆ notify_expiry_enroller()

enrol_plugin::notify_expiry_enroller (   $eid,
  $users,
progress_trace  $trace 
)
protected

Notify person responsible for enrolments that some user enrolments will be expired soon, it is called only if notification of enrollers (aka teachers) is enabled in course.

This is called repeatedly every day for each course if there are any pending expiration in the expiration threshold.

Parameters
int$eid
array$users
progress_trace$trace

◆ process_expirations()

enrol_plugin::process_expirations ( progress_trace  $trace,
  $courseid = null 
)

Do any enrolments need expiration processing.

Plugins that want to call this functionality must implement 'expiredaction' config setting.

Parameters
progress_trace$trace
int$courseidone course, empty mean all
Return values
booltrue if any data processed, false if not

◆ restore_group_member()

enrol_plugin::restore_group_member (   $instance,
  $groupid,
  $userid 
)

Restore user group membership.

Parameters
stdClass$instance
int$groupid
int$userid

Reimplemented in enrol_cohort_plugin, enrol_manual_plugin, and enrol_meta_plugin.

◆ restore_instance()

enrol_plugin::restore_instance ( restore_enrolments_structure_step  $step,
stdClass  $data,
  $course,
  $oldid 
)

◆ restore_role_assignment()

enrol_plugin::restore_role_assignment (   $instance,
  $roleid,
  $userid,
  $contextid 
)

Restore role assignment.

Parameters
stdClass$instance
int$roleid
int$userid
int$contextid

Reimplemented in enrol_database_plugin, enrol_flatfile_plugin, enrol_ldap_plugin, enrol_manual_plugin, and enrol_self_plugin.

◆ restore_sync_course()

enrol_plugin::restore_sync_course (   $course)

Automatic enrol sync executed during restore.

Useful for automatic sync by course->idnumber or course category.

Parameters
stdClass$coursecourse record

Reimplemented in enrol_category_plugin, enrol_database_plugin, and enrol_ldap_plugin.

◆ restore_user_enrolment()

enrol_plugin::restore_user_enrolment ( restore_enrolments_structure_step  $step,
  $data,
  $instance,
  $userid,
  $oldinstancestatus 
)

Restore user enrolment.

Parameters
restore_enrolments_structure_step$step
stdClass$data
stdClass$instance
int$oldinstancestatus
int$userid

Reimplemented in enrol_cohort_plugin, enrol_database_plugin, enrol_flatfile_plugin, enrol_ldap_plugin, enrol_manual_plugin, enrol_meta_plugin, enrol_paypal_plugin, and enrol_self_plugin.

◆ roles_protected()

enrol_plugin::roles_protected ( )

Does this plugin assign protected roles are can they be manually removed?

Return values
bool- false means anybody may tweak roles, it does not use itemid and component when assigning roles

Reimplemented in enrol_flatfile_plugin, enrol_manual_plugin, enrol_paypal_plugin, and enrol_self_plugin.

◆ send_expiry_notifications()

enrol_plugin::send_expiry_notifications (   $trace)

Send expiry notifications.

Plugin that wants to have expiry notification MUST implement following:

  • expirynotifyhour plugin setting,
  • configuration options in instance edit form (expirynotify, notifyall and expirythreshold),
  • notification strings (expirymessageenrollersubject, expirymessageenrollerbody, expirymessageenrolledsubject and expirymessageenrolledbody),
  • expiry_notification provider in db/messages.php,
  • upgrade code that sets default thresholds for existing courses (should be 1 day),
  • something that calls this method, such as cron.
Parameters
progress_trace$trace(accepts bool for backwards compatibility only)

◆ set_config()

enrol_plugin::set_config (   $name,
  $value 
)

Sets plugin config value.

Parameters
string$namename of config
string$valuestring config value, null means delete
Return values
stringvalue

◆ show_enrolme_link()

enrol_plugin::show_enrolme_link ( stdClass  $instance)

Does this plugin support some way to user to self enrol?

Parameters
stdClass$instancecourse enrol instance
Return values
bool- true means show "Enrol me in this course" link in course UI

Reimplemented in enrol_paypal_plugin, and enrol_self_plugin.

◆ sync_user_enrolments()

enrol_plugin::sync_user_enrolments (   $user)

Forces synchronisation of user enrolments.

This is important especially for external enrol plugins, this function is called for all enabled enrol plugins right after every user login.

Parameters
object$useruser record
Return values
void

Reimplemented in enrol_database_plugin, and enrol_ldap_plugin.

◆ try_autoenrol()

enrol_plugin::try_autoenrol ( stdClass  $instance)

Attempt to automatically enrol current user in course without any interaction, calling code has to make sure the plugin and instance are active.

This should return either a timestamp in the future or false.

Parameters
stdClass$instancecourse enrol instance
Return values
bool|intfalse means not enrolled, integer means timeend

◆ try_guestaccess()

enrol_plugin::try_guestaccess ( stdClass  $instance)

Attempt to automatically gain temporary guest access to course, calling code has to make sure the plugin and instance are active.

This should return either a timestamp in the future or false.

Parameters
stdClass$instancecourse enrol instance
Return values
bool|intfalse means no guest access, integer means timeend

Reimplemented in enrol_guest_plugin.

◆ unenrol_user()

enrol_plugin::unenrol_user ( stdClass  $instance,
  $userid 
)

Unenrol user from course, the last unenrolment removes all remaining roles.

Parameters
stdClass$instance
int$userid
Return values
void

Reimplemented in enrol_guest_plugin, and enrol_lti_plugin.

◆ update_instance()

enrol_plugin::update_instance (   $instance,
  $data 
)

Update instance of enrol plugin.

Since
Moodle 3.1
Parameters
stdClass$instance
stdClass$datamodified instance fields
Return values
boolean

Reimplemented in enrol_cohort_plugin, enrol_lti_plugin, enrol_manual_plugin, enrol_meta_plugin, enrol_paypal_plugin, and enrol_self_plugin.

◆ update_status()

enrol_plugin::update_status (   $instance,
  $newstatus 
)

Update instance status.

Override when plugin needs to do some action when enabled or disabled.

Parameters
stdClass$instance
int$newstatusENROL_INSTANCE_ENABLED, ENROL_INSTANCE_DISABLED
Return values
void

Reimplemented in enrol_cohort_plugin, and enrol_meta_plugin.

◆ update_user_enrol()

enrol_plugin::update_user_enrol ( stdClass  $instance,
  $userid,
  $status = NULL,
  $timestart = NULL,
  $timeend = NULL 
)

Store user_enrolments changes and trigger event.

Parameters
stdClass$instance
int$userid
int$status
int$timestart
int$timeend
Return values
void

◆ use_standard_editing_ui()

enrol_plugin::use_standard_editing_ui ( )

This returns false for backwards compatibility, but it is really recommended.

Since
Moodle 3.1
Return values
boolean

Reimplemented in enrol_cohort_plugin, enrol_guest_plugin, enrol_lti_plugin, enrol_manual_plugin, enrol_meta_plugin, enrol_mnet_plugin, enrol_paypal_plugin, and enrol_self_plugin.

◆ user_delete()

enrol_plugin::user_delete (   $user)

Called when user is about to be deleted.

Parameters
object$user
Return values
void

◆ validate_param_types()

enrol_plugin::validate_param_types (   $data,
  $rules 
)

Validate a list of parameter names and types.

Since
Moodle 3.1
Parameters
array$dataarray of ("fieldname"=>value) of submitted data
array$rulesarray of ("fieldname"=>PARAM_X types - or "fieldname"=>array( list of valid options )
Return values
arrayof "element_name"=>"error_description" if there are errors, or an empty array if everything is OK.

The documentation for this class was generated from the following file: