UserFilter Class Reference

Public Member Functions
	__construct ($conditionId='')
	addField ($field)
	delete ()
	generateId ()
	getFields ()
	getId ()
	getUsers ()
	hasField ($className)
	isFulfilled ($userId)
	load ()
	removeField ($fieldId)
	store ()
	toString ()
	__toString ()
	__clone ()

Data Fields
	$fields = []
	$id = ''
	$show_user_count = false

Constructor & Destructor Documentation

__construct

(

$conditionId = ''

)

Standard constructor.

Parameters

String

conditionId

Returns

UserFilter

Member Function Documentation

__clone

(

)

__toString

(

)

addField

(

$field

)

Add a new condition field.

Parameters

ConditionField

fieldId

Returns

UserFilter

delete

(

)

Deletes the condition and all associated fields.

generateId

(

)

Generate a new unique ID.

Parameters

String

tableName

getFields

(

)

Get all fields (without checking for validity according to the current time).

Returns

Array

getId

(

)

Get ID.

Returns

String

getUsers

(

)

Gets all users that fulfill the current condition.

Returns

Array

hasField

(

$className

)

Checks whether the current filter object contains a field of the given type.

Parameters

String

$className

the type to check for

Returns

UserFilterField Return the found field or null if not applicable.

isFulfilled

(

$userId

)

Is the current condition fulfilled (that means, are all required field values matched)?

Returns

boolean

load

(

)

Helper function for loading data from DB.

removeField

(

$fieldId

)

Removes the field with the given ID from the condition fields.

Parameters

String

fieldId

Returns

UserFilter

store

(

)

Stores data to DB.

toString

(

)

Field Documentation

$fields = []

All condition fields that form this condition.

$id = ''

Unique identifier for this condition.

$show_user_count = false

---

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

• lib/classes/admission/UserFilter.class.php