| [ Index ] |
PHP Cross Reference of moodle-2.8 |
[Source view] [Print] [Project Stats]
Guest access plugin.
| Copyright: | 2010 Petr Skoda {@link http://skodak.org} |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 416 lines (15 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
enrol_guest_plugin:: (14 methods):
get_info_icons()
enrol_user()
unenrol_user()
try_guestaccess()
get_newinstance_link()
enrol_page_hook()
course_edit_form()
course_edit_validation()
course_updated()
add_instance()
add_default_instance()
restore_instance()
can_delete_instance()
can_hide_show_instance()
Class: enrol_guest_plugin - X-Ref
| 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 |
| enrol_user(stdClass $instance, $userid, $roleid = null, $timestart = 0, $timeend = 0, $status = null, $recovergrades = null) X-Ref |
| No description |
| unenrol_user(stdClass $instance, $userid) X-Ref |
| No description |
| try_guestaccess(stdClass $instance) X-Ref |
| Attempt to automatically gain temporary guest access to course, calling code has to make sure the plugin and instance are active. param: stdClass $instance course enrol instance return: bool|int false means no guest access, integer means end of cached time |
| 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 |
| course_edit_form($instance, MoodleQuickForm $mform, $data, $context) X-Ref |
| Adds enrol instance UI to course edit form param: object $instance enrol instance or null if does not exist yet param: MoodleQuickForm $mform param: object $data param: object $context context of existing course or parent category if course does not exist return: void |
| course_edit_validation($instance, array $data, $context) X-Ref |
| Validates course edit form data param: object $instance enrol instance or null if does not exist yet param: array $data param: object $context context of existing course or parent category if course does not exist return: array errors array |
| course_updated($inserted, $course, $data) X-Ref |
| Called after updating/inserting course. param: bool $inserted true if course just inserted param: object $course param: object $data form data return: void |
| add_instance($course, array $fields = NULL) X-Ref |
| Add new instance of enrol plugin. param: object $course param: array instance fields return: int id of new instance, null if can not be created |
| add_default_instance($course) X-Ref |
| Add new instance of enrol plugin with default settings. param: object $course return: int id of new instance |
| 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 |
| can_delete_instance($instance) X-Ref |
| Is it possible to delete enrol instance via standard UI? param: object $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 |