| [ Index ] |
PHP Cross Reference of moodle-2.8 |
[Source view] [Print] [Project Stats]
Meta course enrolment plugin.
| Copyright: | 2010 Petr Skoda {@link http://skodak.org} |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 173 lines (6 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
enrol_meta_plugin:: (9 methods):
get_instance_name()
get_newinstance_link()
allow_unenrol_user()
get_user_enrolment_actions()
course_updated()
update_status()
cron()
can_delete_instance()
can_hide_show_instance()
Class: enrol_meta_plugin - X-Ref
Meta course enrolment plugin.| get_instance_name($instance) X-Ref |
| Returns localised name of enrol instance param: stdClass $instance (null is accepted too) return: string |
| 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 |
| allow_unenrol_user(stdClass $instance, stdClass $ue) X-Ref |
| Does this plugin allow manual unenrolment of a specific user? Yes, but only if user suspended... param: stdClass $instance course enrol instance param: stdClass $ue record from user_enrolments table return: bool - true means user with 'enrol/xxx:unenrol' may unenrol this user, false means nobody may touch this user enrolment |
| 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 |
| course_updated($inserted, $course, $data) X-Ref |
| Called after updating/inserting course. param: bool $inserted true if course just inserted param: stdClass $course param: stdClass $data form data return: void |
| update_status($instance, $newstatus) X-Ref |
| Update instance status param: stdClass $instance param: int $newstatus ENROL_INSTANCE_ENABLED, ENROL_INSTANCE_DISABLED return: void |
| cron() X-Ref |
| Called for all enabled enrol plugins that returned true from is_cron_required(). return: void |
| 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 |