Developer Documentation

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 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.
  • Differences Between: [Versions 310 and 34] [Versions 310 and 35] [Versions 34 and 310] [Versions 35 and 310] [Versions 36 and 310] [Versions 37 and 310] [Versions 38 and 310]

    This file contains the User Filter API.

    Copyright: 1999 Martin Dougiamas
    License: GNU GPL v3 or later
    File Size: 354 lines (15 kb)
    Included or required:0 times
    Referenced: 6 times
    Includes or requires: 0 files

    Defines 3 classes

    user_filtering:: (5 methods):

    user_filter_type:: (2 methods):

    name:: (4 methods):

    Class: user_filtering  - X-Ref

    User filtering wrapper class.

    __construct($fieldnames = null, $baseurl = null, $extraparams = null)   X-Ref

    param: array $fieldnames array of visible user fields
    param: string $baseurl base url used for submission/return, null if the same of current page
    param: array $extraparams extra page parameters

    get_field($fieldname, $advanced)   X-Ref
    Creates known user filter if present

    return: object filter
    param: string $fieldname
    param: boolean $advanced

    get_sql_filter($extra='', array $params=null)   X-Ref
    Returns sql where statement based on active user filters

    return: array sql string and $params
    param: string $extra sql
    param: array $params named params (recommended prefix ex)

    display_add()   X-Ref
    Print the add filter form.

    display_active()   X-Ref
    Print the active filter form.

    Class: user_filter_type  - X-Ref

    The base user filter class. All abstract classes must be implemented.

    __construct($name, $label, $advanced)   X-Ref

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

    Class: name  - X-Ref

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

    return: string the filtering condition or null if the filter is disabled
    param: array $data filter settings

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

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

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

    param: moodleform $mform a MoodleForm object to setup

    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