Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/user/filters/ -> profilefield.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 39 and 401]

Profile field filter.

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

Defines 2 classes

user_filter_profilefield:: (2 methods):
  __construct()
  user_filter_profilefield()

name:: (6 methods):
  get_operators()
  get_profile_fields()
  setupForm()
  check_data()
  get_sql_filter()
  get_label()


Class: user_filter_profilefield  - X-Ref

User filter based on values of custom profile fields.

__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_profilefield($name, $label, $advanced)   X-Ref
Old syntax of class constructor. Deprecated in PHP7.


Class: name  - X-Ref

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

return: array of comparison operators

get_profile_fields()   X-Ref
Returns an array of custom profile fields

return: array of profile fields

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

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