Stud.IP  5.4
DatafieldCondition Class Reference
Inheritance diagram for DatafieldCondition:
UserFilterField

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
 
 $sortOrder = 6
 
- Data Fields inherited from UserFilterField
 $compareOperator = ''
 
 $conditionId = ''
 
 $id = ''
 
 $validCompareOperators = []
 
 $validValues = []
 
 $value = null
 
 $sortOrder = 99
 
 $valuesDbTable = ''
 
 $valuesDbIdField = ''
 
 $valuesDbNameField = ''
 
 $userDataDbTable = ''
 
 $userDataDbField = ''
 
 $relations = []
 

Static Public Attributes

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

Additional Inherited Members

- Static Protected Attributes inherited from UserFilterField
static $cached_valid_values
 
static $available_filter_fields
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $typeparam,
  $fieldId = '' 
)

Member Function Documentation

◆ getName()

getName ( )

Get this field's display name.

Returns
String

◆ getParameterizedTypes()

static getParameterizedTypes ( )
static

◆ getUsers()

getUsers (   $restrictions = [])

◆ getUserValues()

getUserValues (   $userId,
  $additional = null 
)

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

Parameters
String$userIdUser to check.
Array$additionaladditional conditions that are required for check.
Returns
array The value(s) for this user.

◆ load()

load ( )

Helper function for loading data from DB.

◆ setValue()

setValue (   $newValue)

Sets a new selected value.

Parameters
StringnewValue
Returns
UserFilterField

◆ store()

store ( )

Stores data to DB.

Field Documentation

◆ $datafield_id

$datafield_id

◆ $datafield_name

$datafield_name

◆ $isParameterized

$isParameterized = true
static

◆ $null_yields

$null_yields

◆ $sortOrder

$sortOrder = 6

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