Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
enrol_manual_deleteselectedusers_operation Class Reference

A bulk operation for the manual enrolment plugin to delete selected users enrolments. More...

Inheritance diagram for enrol_manual_deleteselectedusers_operation:
enrol_bulk_enrolment_operation

Public Member Functions

 get_form ($defaultaction=null, $defaultcustomdata=null)
 Returns a enrol_bulk_enrolment_operation extension form to be used in collecting required information for this operation to be processed.
 
 get_identifier ()
 Returns the title to display for this bulk operation.
 
 get_title ()
 Returns the identifier for this bulk operation.
 
moodle_database process (course_enrolment_manager $manager, array $users, stdClass $properties)
 Processes the bulk operation request for the given userids with the provided properties.
 

Protected Attributes

course_enrolment_manager $manager
 The course enrolment manager.
 
enrol_plugin $plugin
 The enrolment plugin to which this operation belongs.
 

Detailed Description

A bulk operation for the manual enrolment plugin to delete selected users enrolments.

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

Member Function Documentation

◆ get_form()

enrol_manual_deleteselectedusers_operation::get_form ( $defaultaction = null,
$defaultcustomdata = null )

Returns a enrol_bulk_enrolment_operation extension form to be used in collecting required information for this operation to be processed.

Parameters
string | moodle_url | null$defaultaction
mixed$defaultcustomdata
Return values
enrol_manual_editselectedusers_form

Reimplemented from enrol_bulk_enrolment_operation.

◆ get_identifier()

enrol_manual_deleteselectedusers_operation::get_identifier ( )

Returns the title to display for this bulk operation.

Return values
string

Reimplemented from enrol_bulk_enrolment_operation.

◆ get_title()

enrol_manual_deleteselectedusers_operation::get_title ( )

Returns the identifier for this bulk operation.

This is the key used when the plugin returns an array containing all of the bulk operations it supports.

Return values
string

Reimplemented from enrol_bulk_enrolment_operation.

◆ process()

moodle_database enrol_manual_deleteselectedusers_operation::process ( course_enrolment_manager $manager,
array $users,
stdClass $properties )

Processes the bulk operation request for the given userids with the provided properties.

$DB

Parameters
course_enrolment_manager$manager
array$userids
stdClass$propertiesThe data returned by the form.

Reimplemented from enrol_bulk_enrolment_operation.


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