enrol_paypal_plugin Class Reference

Inheritance diagram for enrol_paypal_plugin:

Collaboration diagram for enrol_paypal_plugin:

Public Member Functions
	get_info_icons (array $instances)
	roles_protected ()
	allow_unenrol (stdClass $instance)
	allow_manage (stdClass $instance)
	show_enrolme_link (stdClass $instance)
	add_course_navigation ($instancesnode, stdClass $instance)
	get_action_icons (stdClass $instance)
	get_newinstance_link ($courseid)
	enrol_page_hook (stdClass $instance)

---

Detailed Description

Paypal enrolment plugin implementation.

Author:

Eugene Venter - based on code by Martin Dougiamas and others http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Definition at line 35 of file lib.php.

---

Member Function Documentation

add_course_navigation	(	$	instancesnode,
		stdClass $	instance
	)

Sets up navigation entries.

Parameters:

object

$instance

Returns:

void

Reimplemented from enrol_plugin.

Definition at line 78 of file lib.php.

Here is the call graph for this function:

allow_manage

(

stdClass $

instance

)

Does this plugin allow manual changes in user_enrolments table?

All plugins allowing this must implement 'enrol/xxx:manage' capability

Parameters:

stdClass

$instance

course enrol instance

Returns:

bool - true means it is possible to change enrol period and status in user_enrolments table

Reimplemented from enrol_plugin.

Definition at line 63 of file lib.php.

allow_unenrol

(

stdClass $

instance

)

Does this plugin allow manual unenrolment of all users? All plugins allowing this must implement 'enrol/xxx:unenrol' capability

Parameters:

stdClass

$instance

course enrol instance

Returns:

bool - true means user with 'enrol/xxx:unenrol' may unenrol others freely, false means nobody may touch user_enrolments

Reimplemented from enrol_plugin.

Definition at line 58 of file lib.php.

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

Here is the call graph for this function:

get_action_icons

(

stdClass $

instance

)

Returns edit icons for the page with list of instances

Parameters:

stdClass

$instance

Returns:

array

Reimplemented from enrol_plugin.

Definition at line 95 of file lib.php.

Here is the call graph for this function:

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

Here is the call graph for this function:

roles_protected

(

)

Does this plugin assign protected roles are can they be manually removed?

Returns:

bool - false means anybody may tweak roles, it does not use itemid and component when assigning roles

Reimplemented from enrol_plugin.

Definition at line 53 of file lib.php.

show_enrolme_link

(

stdClass $

instance

)

Does this plugin support some way to user to self enrol?

Parameters:

stdClass

$instance

course enrol instance

Returns:

bool - true means show "Enrol me in this course" link in course UI

Reimplemented from enrol_plugin.

Definition at line 68 of file lib.php.

---

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

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