enrol_manual_editselectedusers_operation Class Reference

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

Inheritance diagram for enrol_manual_editselectedusers_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. More...
	get_identifier ()
	Returns the identifier for this bulk operation. More...
	get_title ()
	Returns the title to display for this bulk operation. More...
	process (course_enrolment_manager $manager, array $users, stdClass $properties)
	Processes the bulk operation request for the given userids with the provided properties. More...

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 edit selected users.

Copyright

2011 Sam Hemelryk

License

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

Member Function Documentation

get_form()

enrol_manual_editselectedusers_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_editselectedusers_operation::get_identifier

(

)

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.

Reimplemented from enrol_bulk_enrolment_operation.

get_title()

enrol_manual_editselectedusers_operation::get_title

(

)

Returns the title to display for this bulk operation.

Return values

string

Reimplemented from enrol_bulk_enrolment_operation.

process()

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

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

Parameters

course_enrolment_manager	$manager
array	$userids
stdClass	$properties	The data returned by the form.

Reimplemented from enrol_bulk_enrolment_operation.

---

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

• enrol/manual/locallib.php