enrol_bulk_enrolment_operation Class Reference

Inheritance diagram for enrol_bulk_enrolment_operation:

Public Member Functions
	__construct (course_enrolment_manager $manager, enrol_plugin $plugin=null)
	get_form ($defaultaction=null, $defaultcustomdata=null)
	get_title ()
	get_identifier ()
	process (course_enrolment_manager $manager, array $users, stdClass $properties)
Protected Attributes
	$manager
	$plugin

---

Detailed Description

This class is used to manage a bulk operations for enrolment plugins.

Copyright:

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

Definition at line 1212 of file locallib.php.

---

Constructor & Destructor Documentation

__construct	(	course_enrolment_manager $	manager,
		enrol_plugin $	plugin = null
	)

Contructor

Parameters:

course_enrolment_manager	$manager
stdClass	$plugin

Definition at line 1231 of file locallib.php.

---

Member Function Documentation

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.

Parameters:

moodle_url | string	$defaultaction
mixed	$defaultcustomdata

Returns:

enrol_bulk_enrolment_change_form|moodleform|false

Reimplemented in enrol_manual_editselectedusers_operation.

Definition at line 1244 of file locallib.php.

get_identifier

(

)

[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.

Returns:

string

Reimplemented in enrol_manual_deleteselectedusers_operation, and enrol_manual_editselectedusers_operation.

get_title

(

)

[abstract]

Returns the title to use for this bulk operation

Returns:

string

Reimplemented in enrol_manual_deleteselectedusers_operation, and enrol_manual_editselectedusers_operation.

process	(	course_enrolment_manager $	manager,
		array $	users,
		stdClass $	properties
	)		[abstract]

Processes the bulk operation on the given users

Parameters:

course_enrolment_manager	$manager
array	$users
stdClass	$properties

Reimplemented in enrol_manual_deleteselectedusers_operation, and enrol_manual_editselectedusers_operation.

---

Field Documentation

$manager [protected]

Definition at line 1218 of file locallib.php.

$plugin [protected]

Definition at line 1224 of file locallib.php.

---

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

• C:/xampp/htdocs/moodle/enrol/locallib.php