[ Index ]

PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008]

title

Body

[close]

/user/filters/ -> lib.php (summary)

(no description)

File Size: 270 lines (11 kb)
Included or required:0 times
Referenced: 3 times
Includes or requires: 0 files

Defines 2 classes

user_filtering:: (5 methods):
  user_filtering()
  get_field()
  get_sql_filter()
  display_add()
  display_active()

user_filter_type:: (5 methods):
  user_filter_type()
  get_sql_filter()
  check_data()
  setupForm()
  get_label()


Class: user_filtering  - X-Ref

User filtering wrapper class.

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

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

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

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

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

param: string $extra sql
return: string

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.

user_filter_type($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

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

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

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

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

param: object $mform a MoodleForm object to setup

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



Generated: Wed Jan 14 11:33:29 2009 Cross-referenced by PHPXref 0.7