[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/enrol/paypal/ -> lib.php (summary)

Paypal enrolment plugin. This plugin allows you to set up paid courses.

Copyright: 2010 Eugene Venter
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 332 lines (13 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

enrol_paypal_plugin:: (17 methods):
  get_currencies()
  get_info_icons()
  roles_protected()
  allow_unenrol()
  allow_manage()
  show_enrolme_link()
  add_course_navigation()
  get_action_icons()
  get_newinstance_link()
  enrol_page_hook()
  restore_instance()
  restore_user_enrolment()
  get_user_enrolment_actions()
  cron()
  sync()
  can_delete_instance()
  can_hide_show_instance()


Class: enrol_paypal_plugin  - X-Ref

Paypal enrolment plugin implementation.

get_currencies()   X-Ref
No description

get_info_icons(array $instances)   X-Ref
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.

param: array $instances all enrol instances of this type in one course
return: array of pix_icon

roles_protected()   X-Ref
No description

allow_unenrol(stdClass $instance)   X-Ref
No description

allow_manage(stdClass $instance)   X-Ref
No description

show_enrolme_link(stdClass $instance)   X-Ref
No description

add_course_navigation($instancesnode, stdClass $instance)   X-Ref
Sets up navigation entries.

param: object $instance
return: void

get_action_icons(stdClass $instance)   X-Ref
Returns edit icons for the page with list of instances

param: stdClass $instance
return: array

get_newinstance_link($courseid)   X-Ref
Returns link to page which may be used to add new instance of enrolment plugin in course.

param: int $courseid
return: moodle_url page url

enrol_page_hook(stdClass $instance)   X-Ref
Creates course enrol form, checks if form submitted
and enrols user if necessary. It can also redirect.

param: stdClass $instance
return: string html text, usually a form in a text box

restore_instance(restore_enrolments_structure_step $step, stdClass $data, $course, $oldid)   X-Ref
Restore instance and map settings.

param: restore_enrolments_structure_step $step
param: stdClass $data
param: stdClass $course
param: int $oldid

restore_user_enrolment(restore_enrolments_structure_step $step, $data, $instance, $userid, $oldinstancestatus)   X-Ref
Restore user enrolment.

param: restore_enrolments_structure_step $step
param: stdClass $data
param: stdClass $instance
param: int $oldinstancestatus
param: int $userid

get_user_enrolment_actions(course_enrolment_manager $manager, $ue)   X-Ref
Gets an array of the user enrolment actions

param: course_enrolment_manager $manager
param: stdClass $ue A user enrolment object
return: array An array of user_enrolment_actions

cron()   X-Ref
No description

sync(progress_trace $trace)   X-Ref
Execute synchronisation.

param: progress_trace $trace
return: int exit code, 0 means ok

can_delete_instance($instance)   X-Ref
Is it possible to delete enrol instance via standard UI?

param: stdClass $instance
return: bool

can_hide_show_instance($instance)   X-Ref
Is it possible to hide/show enrol instance via standard UI?

param: stdClass $instance
return: bool



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1