enrol_bulk_enrolment_operation Class Reference

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

Inheritance diagram for enrol_bulk_enrolment_operation:

Public Member Functions
	__construct (course_enrolment_manager $manager, enrol_plugin $plugin=null)
	Contructor. More...
	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. More...
	get_identifier ()
	Returns the identifier for this bulk operation. More...
	get_title ()
	Returns the title to use for this bulk operation. More...
	process (course_enrolment_manager $manager, array $users, stdClass $properties)
	Processes the bulk operation on the given users. More...

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

Detailed Description

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

Copyright

2011 Sam Hemelryk

License

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

Constructor & Destructor Documentation

__construct()

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

Contructor.

Parameters

course_enrolment_manager	$manager
stdClass	$plugin

Member Function Documentation

get_form()

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.

Parameters

moodle_url | string	$defaultaction
mixed	$defaultcustomdata

Return values

enrol_bulk_enrolment_change_form|moodleform|false

Reimplemented in enrol_self_editselectedusers_operation, enrol_self_deleteselectedusers_operation, enrol_manual_deleteselectedusers_operation, and enrol_manual_editselectedusers_operation.

get_identifier()

enrol_bulk_enrolment_operation::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.

Return values

string

Reimplemented in enrol_self_editselectedusers_operation, enrol_self_deleteselectedusers_operation, enrol_manual_deleteselectedusers_operation, and enrol_manual_editselectedusers_operation.

get_title()

enrol_bulk_enrolment_operation::get_title ( )

abstract

Returns the title to use for this bulk operation.

Return values

string

Reimplemented in enrol_self_editselectedusers_operation, enrol_self_deleteselectedusers_operation, enrol_manual_deleteselectedusers_operation, and enrol_manual_editselectedusers_operation.

process()

enrol_bulk_enrolment_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_self_editselectedusers_operation, enrol_self_deleteselectedusers_operation, enrol_manual_deleteselectedusers_operation, and enrol_manual_editselectedusers_operation.

---

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

• mnet/service/enrol/locallib.php