Moodle  2.2.1
http://www.collinsharper.com
user_filtering Class Reference

Public Member Functions

 user_filtering ($fieldnames=null, $baseurl=null, $extraparams=null)
 get_field ($fieldname, $advanced)
 get_sql_filter ($extra='', array $params=null)
 display_add ()
 display_active ()

Data Fields

 $_fields
 $_addform
 $_activeform

Detailed Description

User filtering wrapper class.

Definition at line 18 of file lib.php.


Member Function Documentation

Print the active filter form.

Definition at line 210 of file lib.php.

Print the add filter form.

Definition at line 203 of file lib.php.

get_field ( fieldname,
advanced 
)

Creates known user filter if present

Parameters:
string$fieldname
boolean$advanced
Returns:
object filter

Definition at line 101 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

get_sql_filter ( extra = '',
array params = null 
)

Returns sql where statement based on active user filters

Parameters:
string$extrasql
arraynamed params (recommended prefix ex)
Returns:
array sql string and $params

Definition at line 169 of file lib.php.

user_filtering ( fieldnames = null,
baseurl = null,
extraparams = null 
)

Contructor

Parameters:
arrayarray of visible user fields
stringbase url used for submission/return, null if the same of current page
arrayextra page parameters

Definition at line 29 of file lib.php.

Here is the call graph for this function:


Field Documentation

$_activeform

Definition at line 21 of file lib.php.

$_addform

Definition at line 20 of file lib.php.

$_fields

Definition at line 19 of file lib.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations