Simple value select filter.
Copyright: | 1999 Martin Dougiamas http://dougiamas.com |
License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
File Size: | 130 lines (4 kb) |
Included or required: | 0 times |
Referenced: | 1 time |
Includes or requires: | 0 files |
user_filter_simpleselect:: (2 methods):
__construct()
user_filter_simpleselect()
name:: (4 methods):
setupForm()
check_data()
get_sql_filter()
get_label()
Class: user_filter_simpleselect - X-Ref
Generic filter based on a list of values.__construct($name, $label, $advanced, $field, $options) 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 param: string $field user table filed name param: array $options select options |
user_filter_simpleselect($name, $label, $advanced, $field, $options) X-Ref |
Old syntax of class constructor. Deprecated in PHP7. |
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: object $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 |