user_filtering Class Reference

This file contains the User Filter API. More...

Public Member Functions
	__construct ($fieldnames=null, $baseurl=null, $extraparams=null)
	Contructor.
	display_active ()
	Print the active filter form.
	display_add ()
	Print the add filter form.
	get_field ($fieldname, $advanced)
	Creates known user filter if present.
	get_sql_filter ($extra='', array $params=null)
	Returns sql where statement based on active user filters.

Public Attributes
user_active_filter_form	$_activeform
user_add_filter_form	$_addform
array	$_fields

Detailed Description

This file contains the User Filter API.

Copyright

1999 Martin Dougiamas http://dougiamas.com

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later User filtering wrapper class.

Copyright

1999 Martin Dougiamas http://dougiamas.com

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

user_filtering::__construct	(		$fieldnames = null,
			$baseurl = null,
			$extraparams = null )

Contructor.

Parameters

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

Member Function Documentation

get_field()

user_filtering::get_field	(		$fieldname,
			$advanced )

Creates known user filter if present.

Parameters

string	$fieldname
boolean	$advanced

Return values

object

filter

get_sql_filter()

user_filtering::get_sql_filter	(		$extra = '',
		array	$params = null )

Returns sql where statement based on active user filters.

Parameters

string	$extra	sql
array	$params	named params (recommended prefix ex)

Return values

array

sql string and $params

---

The documentation for this class was generated from the following file:

• user/filters/lib.php