Global role filter.
More...
|
| __construct ($name, $label, $advanced) |
| Constructor.
|
|
| check_data ($formdata) |
| Retrieves data from the form data.
|
|
| get_label ($data) |
| Returns a human friendly description of the filter used as label.
|
|
| get_roles () |
| Returns an array of available roles.
|
|
| get_sql_filter ($data) |
| Returns the condition to be used with SQL where.
|
|
| setupForm (&$mform) |
| Adds controls specific to this filter in the form.
|
|
| user_filter_globalrole ($name, $label, $advanced) |
| Old syntax of class constructor.
|
|
| user_filter_type ($name, $label, $advanced) |
| Old syntax of class constructor.
|
|
|
bool | $_advanced |
| Advanced form element flag.
|
|
string | $_label |
| The label of this filter instance.
|
|
string | $_name |
| The name of this filter instance.
|
|
Global role filter.
- Copyright
- 1999 Martin Dougiamas http://dougiamas.com
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later User filter based on global roles.
- Copyright
- 1999 Martin Dougiamas http://dougiamas.com
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ __construct()
user_filter_globalrole::__construct |
( |
| $name, |
|
|
| $label, |
|
|
| $advanced ) |
Constructor.
- Parameters
-
string | $name | the name of the filter instance |
string | $label | the label of the filter instance |
boolean | $advanced | advanced form element flag |
Reimplemented from user_filter_type.
◆ check_data()
user_filter_globalrole::check_data |
( |
| $formdata | ) |
|
Retrieves data from the form data.
- Parameters
-
object | $formdata | data submited with the form |
- Return values
-
mixed | array filter data or false when filter not set |
Reimplemented from user_filter_type.
◆ get_label()
user_filter_globalrole::get_label |
( |
| $data | ) |
|
Returns a human friendly description of the filter used as label.
- Parameters
-
array | $data | filter settings |
- Return values
-
string | active filter label |
Reimplemented from user_filter_type.
◆ get_roles()
user_filter_globalrole::get_roles |
( |
| ) |
|
Returns an array of available roles.
- Return values
-
◆ get_sql_filter()
user_filter_globalrole::get_sql_filter |
( |
| $data | ) |
|
Returns the condition to be used with SQL where.
- Parameters
-
array | $data | filter settings |
- Return values
-
array | sql string and $params |
Reimplemented from user_filter_type.
◆ setupForm()
user_filter_globalrole::setupForm |
( |
& | $mform | ) |
|
Adds controls specific to this filter in the form.
- Parameters
-
object | $mform | a MoodleForm object to setup |
Reimplemented from user_filter_type.
◆ user_filter_globalrole()
user_filter_globalrole::user_filter_globalrole |
( |
| $name, |
|
|
| $label, |
|
|
| $advanced ) |
Old syntax of class constructor.
Deprecated in PHP7.
- Deprecated
- since Moodle 3.1
◆ user_filter_type()
user_filter_type::user_filter_type |
( |
| $name, |
|
|
| $label, |
|
|
| $advanced ) |
|
inherited |
Old syntax of class constructor.
Deprecated in PHP7.
- Deprecated
- since Moodle 3.1
The documentation for this class was generated from the following file: