Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/user/filters/ -> text.php (source)

[Source view]

Differences Between: [Versions 400 and 401] [Versions 400 and 402] [Versions 400 and 403]

Text field filter

Copyright: 1999 Martin Dougiamas http://dougiamas.com
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 194 lines (7 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 2 classes

user_filter_text:: (2 methods):
  __construct()
  user_filter_text()

name:: (5 methods):
  getOperators()
  setupForm()
  check_data()
  get_sql_filter()
  get_label()


Class: user_filter_text  - X-Ref

Generic filter for text fields.

__construct($name, $label, $advanced, $field)   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

user_filter_text($name, $label, $advanced, $field)   X-Ref
Old syntax of class constructor. Deprecated in PHP7.


Class: name  - X-Ref

getOperators()   X-Ref
Returns an array of comparison operators

return: array of comparison operators

setupForm(&$mform)   X-Ref
Adds controls specific to this filter in the form.

param: object $mform a MoodleForm object to setup

check_data($formdata)   X-Ref
Retrieves data from the form data

return: mixed array filter data or false when filter not set
param: object $formdata data submited with the form

get_sql_filter($data)   X-Ref
Returns the condition to be used with SQL where

return: array sql string and $params
param: array $data filter settings

get_label($data)   X-Ref
Returns a human friendly description of the filter used as label.

return: string active filter label
param: array $data filter settings