See Release Notes
Long Term Support Release
Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]
This file contains the User Filter API.
Copyright: | 1999 Martin Dougiamas http://dougiamas.com |
License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
File Size: | 361 lines (16 kb) |
Included or required: | 0 times |
Referenced: | 7 times |
Includes or requires: | 0 files |
user_filtering:: (5 methods):
__construct()
get_field()
get_sql_filter()
display_add()
display_active()
user_filter_type:: (2 methods):
__construct()
user_filter_type()
name:: (4 methods):
get_sql_filter()
check_data()
setupForm()
get_label()
Class: user_filtering - X-Ref
User filtering wrapper class.__construct($fieldnames = null, $baseurl = null, $extraparams = null) X-Ref |
Contructor param: array $fieldnames array of visible user fields param: string $baseurl base url used for submission/return, null if the same of current page param: array $extraparams extra page parameters |
get_field($fieldname, $advanced) X-Ref |
Creates known user filter if present param: string $fieldname param: boolean $advanced return: object filter |
get_sql_filter($extra='', array $params=null) X-Ref |
Returns sql where statement based on active user filters param: string $extra sql param: array $params named params (recommended prefix ex) return: array sql string and $params |
display_add() X-Ref |
Print the add filter form. |
display_active() X-Ref |
Print the active filter form. |
Class: user_filter_type - X-Ref
The base user filter class. All abstract classes must be implemented.__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_type($name, $label, $advanced) X-Ref |
Old syntax of class constructor. Deprecated in PHP7. |
get_sql_filter($data) X-Ref |
Returns the condition to be used with SQL where param: array $data filter settings return: string the filtering condition or null if the filter is disabled |
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 |
setupForm(&$mform) X-Ref |
Adds controls specific to this filter in the form. param: moodleform $mform a MoodleForm object to setup |
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 |