DatafieldCondition Class Reference

Inheritance diagram for DatafieldCondition:

Collaboration diagram for DatafieldCondition:

Public Member Functions
	__construct ($typeparam, $fieldId='')
	getName ()
	getUsers ($restrictions=[])
	getUserValues ($userId, $additional=null)
	load ()
	setValue ($newValue)
	store ()
Public Member Functions inherited from UserFilterField
	__construct ($fieldId='')
	checkValue ($values)
	delete ()
	generateId ()
	getCompareOperator ()
	getCompareOperatorAsText ()
	getId ()
	getName ()
	getUsers ($restrictions=[])
	getUserValues ($userId, $additional=null)
	getValidCompareOperators ()
	getValidValues ()
	getValue ()
	load ()
	setCompareOperator ($newOperator)
	setConditionId ($id)
	setValue ($newValue)
	store ()
	__clone ()

Static Public Member Functions
static	getParameterizedTypes ()
Static Public Member Functions inherited from UserFilterField
static	getParameterizedTypes ()
static	getAvailableFilterFields ()

Data Fields
	$datafield_id
	$null_yields
	$datafield_name
Data Fields inherited from UserFilterField
	$compareOperator = ''
	$conditionId = ''
	$id = ''
	$validCompareOperators = []
	$validValues = []
	$value = null
	$valuesDbTable = ''
	$valuesDbIdField = ''
	$valuesDbNameField = ''
	$userDataDbTable = ''
	$userDataDbField = ''
	$relations = []

Static Public Attributes
static	$isParameterized = true
Static Public Attributes inherited from UserFilterField
static	$isParameterized = false

Constructor & Destructor Documentation

__construct()

__construct	(		$typeparam,
			$fieldId = ''
	)

See also

UserFilterField::__construct

Here is the call graph for this function:

Member Function Documentation

getName()

getName

(

)

Get this field's display name.

Returns

String

Reimplemented from UserFilterField.

getParameterizedTypes()

static getParameterizedTypes ( )

static

Reimplemented from UserFilterField.

Here is the call graph for this function:

getUsers()

getUsers

(

$restrictions = []

)

Compares all the users' values by using the specified compare operator and returns all users that fulfill the condition. This can be an important information when checking on validity of a combination of conditions.

Parameters

Array

$restrictions

values from other fields that restrict the valid values for a user (e.g. a semester of study in a given subject)

Returns

Array All users that are affected by the current condition field.

Reimplemented from UserFilterField.

Here is the call graph for this function:

getUserValues()

getUserValues	(		$userId,
			$additional = null
	)

Gets the value for the given user that is relevant for this

Parameters

String	$userId	User to check.
	Array	additional conditions that are required for check.

Returns

The value(s) for this user.

Reimplemented from UserFilterField.

Here is the call graph for this function:

load()

load

(

)

Helper function for loading data from DB.

Reimplemented from UserFilterField.

Here is the call graph for this function:

Here is the caller graph for this function:

setValue()

setValue

(

$newValue

)

Sets a new selected value.

Parameters

String

newValue

Returns

UserFilterField

Reimplemented from UserFilterField.

store()

store

(

)

Stores data to DB.

Reimplemented from UserFilterField.

Here is the call graph for this function:

Field Documentation

$datafield_id

$datafield_id

$datafield_name

$datafield_name

$isParameterized

$isParameterized = true

static

$null_yields

$null_yields

---

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

• lib/classes/admission/userfilter/DatafieldCondition.class.php