enrol_guest_plugin Class Reference

Inheritance diagram for enrol_guest_plugin:

Collaboration diagram for enrol_guest_plugin:

Public Member Functions
	get_info_icons (array $instances)
	enrol_user (stdClass $instance, $userid, $roleid=NULL, $timestart=0, $timeend=0, $status=NULL)
	unenrol_user (stdClass $instance, $userid)
	try_guestaccess (stdClass $instance)
	get_newinstance_link ($courseid)
	enrol_page_hook (stdClass $instance)
	course_edit_form ($instance, MoodleQuickForm $mform, $data, $context)
	course_edit_validation ($instance, array $data, $context)
	course_updated ($inserted, $course, $data)
	add_instance ($course, array $fields=NULL)
	add_default_instance ($course)

---

Detailed Description

Definition at line 31 of file lib.php.

---

Member Function Documentation

add_default_instance

(

$

course

)

Add new instance of enrol plugin with default settings.

Parameters:

object

$course

Returns:

int id of new instance

Reimplemented from enrol_plugin.

Definition at line 359 of file lib.php.

Here is the call graph for this function:

add_instance	(	$	course,
		array $	fields = NULL
	)

Add new instance of enrol plugin.

Parameters:

object	$course
	array	instance fields

Returns:

int id of new instance, null if can not be created

Reimplemented from enrol_plugin.

Definition at line 344 of file lib.php.

course_edit_form	(	$	instance,
		MoodleQuickForm $	mform,
		$	data,
		$	context
	)

Adds enrol instance UI to course edit form

Parameters:

object	$instance	enrol instance or null if does not exist yet
MoodleQuickForm	$mform
object	$data
object	$context	context of existing course or parent category if course does not exist

Returns:

void

Reimplemented from enrol_plugin.

Definition at line 178 of file lib.php.

Here is the call graph for this function:

course_edit_validation	(	$	instance,
		array $	data,
		$	context
	)

Validates course edit form data

Parameters:

object	$instance	enrol instance or null if does not exist yet
array	$data
object	$context	context of existing course or parent category if course does not exist

Returns:

array errors array

Reimplemented from enrol_plugin.

Definition at line 227 of file lib.php.

Here is the call graph for this function:

course_updated	(	$	inserted,
		$	course,
		$	data
	)

Called after updating/inserting course.

Parameters:

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

Returns:

void

Reimplemented from enrol_plugin.

Definition at line 280 of file lib.php.

Here is the call graph for this function:

enrol_page_hook

(

stdClass $

instance

)

Creates course enrol form, checks if form submitted and enrols user if necessary. It can also redirect.

Parameters:

stdClass

$instance

Returns:

string html text, usually a form in a text box

Reimplemented from enrol_plugin.

Definition at line 124 of file lib.php.

Here is the call graph for this function:

enrol_user	(	stdClass $	instance,
		$	userid,
		$	roleid = NULL,
		$	timestart = 0,
		$	timeend = 0,
		$	status = NULL
	)

Enrol user into course via enrol instance.

Parameters:

stdClass	$instance
int	$userid
int	$roleid	optional role id
int	$timestart	0 means unknown
int	$timeend	0 means forever
int	$status	default to ENROL_USER_ACTIVE for new enrolments, no change by default in updates

Returns:

void

Reimplemented from enrol_plugin.

Definition at line 55 of file lib.php.

get_info_icons

(

array $

instances

)

Returns optional enrolment information icons.

This is used in course list for quick overview of enrolment options.

We are not using single instance parameter because sometimes we might want to prevent icon repetition when multiple instances of one type exist. One instance may also produce several icons.

Parameters:

array

$instances

all enrol instances of this type in one course

Returns:

array of pix_icon

Reimplemented from enrol_plugin.

Definition at line 45 of file lib.php.

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 101 of file lib.php.

Here is the call graph for this function:

try_guestaccess

(

stdClass $

instance

)

Attempt to automatically gain temporary guest access to course, calling code has to make sure the plugin and instance are active.

Parameters:

stdClass

$instance

course enrol instance

Returns:

bool|int false means no guest access, integer means end of cached time

Reimplemented from enrol_plugin.

Definition at line 72 of file lib.php.

Here is the call graph for this function:

unenrol_user	(	stdClass $	instance,
		$	userid
	)

Unenrol user from course, the last unenrolment removes all remaining roles.

Parameters:

stdClass	$instance
int	$userid

Returns:

void

Reimplemented from enrol_plugin.

Definition at line 60 of file lib.php.

---

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

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