enrol_meta_plugin Class Reference

Inheritance diagram for enrol_meta_plugin:

Collaboration diagram for enrol_meta_plugin:

Public Member Functions
	get_instance_name ($instance)
	get_newinstance_link ($courseid)
	allow_unenrol_user (stdClass $instance, stdClass $ue)
	get_user_enrolment_actions (course_enrolment_manager $manager, $ue)
	course_updated ($inserted, $course, $data)
	update_status ($instance, $newstatus)
	cron ()

---

Detailed Description

Meta course enrolment plugin.

Author:

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

Definition at line 33 of file lib.php.

---

Member Function Documentation

allow_unenrol_user	(	stdClass $	instance,
		stdClass $	ue
	)

Does this plugin allow manual unenrolment of a specific user? Yes, but only if user suspended...

Parameters:

stdClass	$instance	course enrol instance
stdClass	$ue	record from user_enrolments table

Returns:

bool - true means user with 'enrol/xxx:unenrol' may unenrol this user, false means nobody may touch this user enrolment

Reimplemented from enrol_plugin.

Definition at line 78 of file lib.php.

Here is the caller graph for this function:

course_updated	(	$	inserted,
		$	course,
		$	data
	)

Called after updating/inserting course.

Parameters:

bool	$inserted	true if course just inserted
stdClass	$course
stdClass	$data	form data

Returns:

void

Reimplemented from enrol_plugin.

Definition at line 114 of file lib.php.

Here is the call graph for this function:

cron

(

)

Called for all enabled enrol plugins that returned true from is_cron_required().

Returns:

void

Reimplemented from enrol_plugin.

Definition at line 146 of file lib.php.

Here is the call graph for this function:

get_instance_name

(

$

instance

)

Returns localised name of enrol instance

Parameters:

stdClass

$instance

(null is accepted too)

Returns:

string

Reimplemented from enrol_plugin.

Definition at line 41 of file lib.php.

Here is the call graph for this function:

get_newinstance_link

(

$

courseid

)

Returns link to page which may be used to add new instance of enrolment plugin in course.

Parameters:

int

$courseid

Returns:

moodle_url page url

Reimplemented from enrol_plugin.

Definition at line 60 of file lib.php.

Here is the call graph for this function:

get_user_enrolment_actions	(	course_enrolment_manager $	manager,
		$	ue
	)

Gets an array of the user enrolment actions

Parameters:

course_enrolment_manager	$manager
stdClass	$ue	A user enrolment object

Returns:

array An array of user_enrolment_actions

Reimplemented from enrol_plugin.

Definition at line 93 of file lib.php.

Here is the call graph for this function:

update_status	(	$	instance,
		$	newstatus
	)

Update instance status

Parameters:

stdClass	$instance
int	$newstatus	ENROL_INSTANCE_ENABLED, ENROL_INSTANCE_DISABLED

Returns:

void

Reimplemented from enrol_plugin.

Definition at line 133 of file lib.php.

Here is the call graph for this function:

---

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

• C:/xampp/htdocs/moodle/enrol/meta/lib.php