Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/user/filters/ -> checkbox.php (source)

[Source view]

Generic checkbox filter. This will create generic filter with checkbox option and can be used for disabling other elements for specific condition.

Copyright: 2011 Rajesh Taneja
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 139 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

user_filter_checkbox:: (5 methods):
  __construct()
  setupForm()
  check_data()
  get_sql_filter()
  get_label()


Class: user_filter_checkbox  - X-Ref

Generic filter based for checkbox and can be used for disabling items

__construct($name, $label, $advanced, $field, $disableelements=null)   X-Ref
Constructor, initalize user_filter_type and sets $disableelements array
with list of elements to be diabled by checkbox.

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: mixed $field user table field/fields name for comparison
param: array $disableelements name of fields which should be disabled if this checkbox is checked.

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

param: moodleform $mform a MoodleQuickForm object in which element will be added

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