| [ Index ] |
PHP Cross Reference of moodle-2.8 |
[Source view] [Print] [Project Stats]
Manual enrolment plugin main library file.
| Copyright: | 2010 Petr Skoda {@link http://skodak.org} |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 605 lines (24 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
enrol_manual_plugin:: (23 methods):
roles_protected()
allow_enrol()
allow_unenrol()
allow_manage()
get_manual_enrol_link()
add_course_navigation()
get_action_icons()
get_newinstance_link()
add_default_instance()
add_instance()
get_manual_enrol_button()
cron()
sync()
get_enroller()
get_user_enrolment_actions()
get_bulk_operations()
restore_instance()
restore_user_enrolment()
restore_role_assignment()
restore_group_member()
can_delete_instance()
can_hide_show_instance()
enrol_cohort()
Class: enrol_manual_plugin - X-Ref
| roles_protected() X-Ref |
| No description |
| allow_enrol(stdClass $instance) X-Ref |
| No description |
| allow_unenrol(stdClass $instance) X-Ref |
| No description |
| allow_manage(stdClass $instance) X-Ref |
| No description |
| get_manual_enrol_link($instance) X-Ref |
| Returns link to manual enrol UI if exists. Does the access control tests automatically. param: stdClass $instance return: moodle_url |
| add_course_navigation($instancesnode, stdClass $instance) X-Ref |
| Returns enrolment instance manage link. By defaults looks for manage.php file and tests for manage capability. param: navigation_node $instancesnode param: stdClass $instance return: moodle_url; |
| 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 |
| add_default_instance($course) X-Ref |
| Add new instance of enrol plugin with default settings. param: stdClass $course return: int id of new instance, null if can not be created |
| add_instance($course, array $fields = NULL) X-Ref |
| Add new instance of enrol plugin. param: stdClass $course param: array instance fields return: int id of new instance, null if can not be created |
| get_manual_enrol_button(course_enrolment_manager $manager) X-Ref |
| Returns a button to manually enrol users through the manual enrolment plugin. By default the first manual enrolment plugin instance available in the course is used. If no manual enrolment instances exist within the course then false is returned. This function also adds a quickenrolment JS ui to the page so that users can be enrolled via AJAX. param: course_enrolment_manager $manager return: enrol_user_button |
| cron() X-Ref |
| Enrol cron support. return: void |
| sync(progress_trace $trace, $courseid = null) X-Ref |
| Sync all meta course links. param: progress_trace $trace param: int $courseid one course, empty mean all return: int 0 means ok, 1 means error, 2 means plugin disabled |
| get_enroller($instanceid) X-Ref |
| Returns the user who is responsible for manual enrolments in given instance. Usually it is the first editing teacher - the person with "highest authority" as defined by sort_by_roleassignment_authority() having 'enrol/manual:manage' capability. param: int $instanceid enrolment instance id return: stdClass user record |
| 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 |
| get_bulk_operations(course_enrolment_manager $manager) X-Ref |
| The manual plugin has several bulk operations that can be performed. param: course_enrolment_manager $manager return: array |
| 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 |
| restore_role_assignment($instance, $roleid, $userid, $contextid) X-Ref |
| Restore role assignment. param: stdClass $instance param: int $roleid param: int $userid param: int $contextid |
| restore_group_member($instance, $groupid, $userid) X-Ref |
| Restore user group membership. param: stdClass $instance param: int $groupid param: int $userid |
| 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 |
| enrol_cohort(stdClass $instance, $cohortid, $roleid = null, $timestart = 0, $timeend = 0, $status = null, $recovergrades = null) X-Ref |
| Enrol all not enrolled cohort members into course via enrol instance. param: stdClass $instance param: int $cohortid param: int $roleid optional role id param: int $timestart 0 means unknown param: int $timeend 0 means forever param: int $status default to ENROL_USER_ACTIVE for new enrolments, no change by default in updates param: bool $recovergrades restore grade history |
| Generated: Fri Nov 28 20:29:05 2014 | Cross-referenced by PHPXref 0.7.1 |