| [ Index ] |
PHP Cross Reference of moodle-2.8 |
[Source view] [Print] [Project Stats]
Cohort 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: | 325 lines (12 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
enrol_cohort_plugin:: (15 methods):
can_delete_instance()
get_instance_name()
get_newinstance_link()
can_add_new_instances()
get_action_icons()
cron()
course_updated()
update_status()
allow_unenrol_user()
get_user_enrolment_actions()
restore_instance()
restore_user_enrolment()
restore_group_member()
can_hide_show_instance()
enrol_cohort_allow_group_member_remove()
Class: enrol_cohort_plugin - X-Ref
Cohort enrolment plugin implementation.| can_delete_instance($instance) X-Ref |
| Is it possible to delete enrol instance via standard UI? param: stdClass $instance return: bool |
| 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 |
| can_add_new_instances($courseid) X-Ref |
| Given a courseid this function returns true if the user is able to enrol or configure cohorts. AND there are cohorts that the user can view. param: int $courseid return: bool |
| get_action_icons(stdClass $instance) X-Ref |
| Returns edit icons for the page with list of instances. param: stdClass $instance return: array |
| cron() X-Ref |
| Called for all enabled enrol plugins that returned true from is_cron_required(). return: void |
| 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 |
| 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 |
| 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_group_member($instance, $groupid, $userid) X-Ref |
| Restore user group membership. param: stdClass $instance param: int $groupid param: int $userid |
| 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_allow_group_member_remove($itemid, $groupid, $userid) X-Ref |
| Prevent removal of enrol roles. param: int $itemid param: int $groupid param: int $userid return: bool |
| Generated: Fri Nov 28 20:29:05 2014 | Cross-referenced by PHPXref 0.7.1 |