[ Index ]

PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008]

title

Body

[close]

/enrol/manual/ -> enrol.php (summary)

(no description)

File Size: 441 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

enrolment_plugin_manual:: (8 methods):
  print_entry()
  check_entry()
  check_group_entry()
  config_form()
  process_config()
  cron()
  get_access_icons()
  print_enrolmentkeyfrom()


Class: enrolment_plugin_manual  - X-Ref

enrolment_plugin_manual is the default enrolment plugin

This class provides all the functionality for an enrolment plugin
In fact it includes all the code for the default, "manual" method
so that other plugins can override these as necessary.
print_entry($course)   X-Ref
Prints the entry form/page for this enrolment

This is only called from course/enrol.php
Most plugins will probably override this to print payment
forms etc, or even just a notice to say that manual enrolment
is disabled

param: course  current course object

check_entry($form, $course)   X-Ref
The other half to print_entry, this checks the form data

This function checks that the user has completed the task on the
enrolment entry page and then enrolls them.

param: form    the form data submitted, as an object
param: course  the current course, as an object

check_group_entry($courseid, $password)   X-Ref
Check if the given enrolment key matches a group enrolment key for the given course

param: courseid  the current course id
param: password  the submitted enrolment key

config_form($frm)   X-Ref
Prints a form for configuring the current enrolment plugin

This function is called from admin/enrol.php, and outputs a
full page with a form for defining the current enrolment plugin.

param: frm  an object containing all the data for this page

process_config($config)   X-Ref
Processes and stored configuration data for the enrolment plugin

param: config  all the configuration data as entered by the admin

cron()   X-Ref
Notify users about enrolments that are going to expire soon!
This function is run by admin/cron.php

return: void

get_access_icons($course)   X-Ref
Returns the relevant icons for a course

param: course  the current course, as an object

print_enrolmentkeyfrom($course)   X-Ref
Prints the message telling you were to get the enrolment key
appropriate for the prevailing circumstances
A bit clunky because I didn't want to change the standard strings




Generated: Wed Jan 14 11:33:29 2009 Cross-referenced by PHPXref 0.7