Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
- Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/user/filters/ -> courserole.php (source)
Course role filter
| Copyright: | 1999 Martin Dougiamas http://dougiamas.com |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 193 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 2 classes
user_filter_courserole:: (2 methods):
__construct()
user_filter_courserole()
name:: (6 methods):
get_roles()
get_course_categories()
setupForm()
check_data()
get_sql_filter()
get_label()
Class: user_filter_courserole - X-Ref
User filter based on roles in a course identified by its shortname.| __construct($name, $label, $advanced) X-Ref |
| Constructor param: string $name the name of the filter instance param: string $label the label of the filter instance param: boolean $advanced advanced form element flag |
| user_filter_courserole($name, $label, $advanced) X-Ref |
| Old syntax of class constructor. Deprecated in PHP7. |
| get_roles() X-Ref |
| Returns an array of available roles return: array of availble roles |
| get_course_categories() X-Ref |
| Returns an array of course categories return: array of course categories |
| setupForm(&$mform) X-Ref |
| Adds controls specific to this filter in the form. param: moodleform $mform a MoodleForm object to setup |
| check_data($formdata) X-Ref |
| Retrieves data from the form data param: stdClass $formdata data submited with the form return: mixed array filter data or false when filter not set |
| get_sql_filter($data) X-Ref |
| Returns the condition to be used with SQL where param: array $data filter settings return: array sql string and $params |
| get_label($data) X-Ref |
| Returns a human friendly description of the filter used as label. param: array $data filter settings return: string active filter label |
