Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
This class is used to manage a bulk operations for enrolment plugins. More...
Public Member Functions | |
__construct (course_enrolment_manager $manager, enrol_plugin $plugin=null) | |
Contructor. | |
get_form ($defaultaction=null, $defaultcustomdata=null) | |
Returns a moodleform used for this operation, or false if no form is required and the action should be immediatly processed. | |
get_identifier () | |
Returns the identifier for this bulk operation. | |
get_title () | |
Returns the title to use for this bulk operation. | |
process (course_enrolment_manager $manager, array $users, stdClass $properties) | |
Processes the bulk operation on the given users. | |
Protected Attributes | |
course_enrolment_manager | $manager |
The course enrolment manager. | |
enrol_plugin | $plugin |
The enrolment plugin to which this operation belongs. | |
This class is used to manage a bulk operations for enrolment plugins.
enrol_bulk_enrolment_operation::__construct | ( | course_enrolment_manager | $manager, |
enrol_plugin | $plugin = null ) |
Contructor.
course_enrolment_manager | $manager | |
stdClass | $plugin |
enrol_bulk_enrolment_operation::get_form | ( | $defaultaction = null, | |
$defaultcustomdata = null ) |
Returns a moodleform used for this operation, or false if no form is required and the action should be immediatly processed.
moodle_url | string | $defaultaction | |
mixed | $defaultcustomdata |
enrol_bulk_enrolment_change_form|moodleform|false |
Reimplemented in enrol_manual_deleteselectedusers_operation, enrol_manual_editselectedusers_operation, enrol_self_deleteselectedusers_operation, and enrol_self_editselectedusers_operation.
|
abstract |
Returns the identifier for this bulk operation.
This should be the same identifier used by the plugins function when returning all of its bulk operations.
string |
Reimplemented in enrol_manual_deleteselectedusers_operation, enrol_manual_editselectedusers_operation, enrol_self_deleteselectedusers_operation, and enrol_self_editselectedusers_operation.
|
abstract |
Returns the title to use for this bulk operation.
string |
Reimplemented in enrol_manual_deleteselectedusers_operation, enrol_manual_editselectedusers_operation, enrol_self_deleteselectedusers_operation, and enrol_self_editselectedusers_operation.
|
abstract |
Processes the bulk operation on the given users.
course_enrolment_manager | $manager | |
array | $users | |
stdClass | $properties |
Reimplemented in enrol_manual_deleteselectedusers_operation, enrol_manual_editselectedusers_operation, enrol_self_deleteselectedusers_operation, and enrol_self_editselectedusers_operation.