UserFilter Class Reference
Collaboration diagram for UserFilter:
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()
| __construct | ( | $conditionId = '' | ) |
Standard constructor.
- Parameters
-
String conditionId
- Returns
- UserFilter
Here is the call graph for this function:
Member Function Documentation
◆ __clone()
| __clone | ( | ) |
◆ __toString()
| __toString | ( | ) |
Here is the call graph for this function:
◆ addField()
| addField | ( | $field | ) |
◆ delete()
| delete | ( | ) |
Deletes the condition and all associated fields.
Here is the call graph for this function:
◆ generateId()
| generateId | ( | ) |
Generate a new unique ID.
- Parameters
-
String tableName
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getFields()
| getFields | ( | ) |
Get all fields (without checking for validity according to the current time).
- Returns
- Array
◆ getId()
| getId | ( | ) |
Get ID.
- Returns
- String
◆ getUsers()
| getUsers | ( | ) |
Gets all users that fulfill the current condition.
- Returns
- Array
Here is the call graph for this function:
◆ hasField()
| 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.
Here is the caller graph for this function:
◆ isFulfilled()
| isFulfilled | ( | $userId | ) |
Is the current condition fulfilled (that means, are all required field values matched)?
- Returns
- boolean
◆ load()
| load | ( | ) |
Helper function for loading data from DB.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ removeField()
| removeField | ( | $fieldId | ) |
Removes the field with the given ID from the condition fields.
- Parameters
-
String fieldId
- Returns
- UserFilter
◆ store()
| store | ( | ) |
Stores data to DB.
Here is the call graph for this function:
◆ toString()
| toString | ( | ) |
Here is the caller graph for this function:
Field Documentation
◆ $fields
| $fields = [] |
All condition fields that form this condition.
◆ $id
| $id = '' |
Unique identifier for this condition.
◆ $show_user_count
| $show_user_count = false |
The documentation for this class was generated from the following file:
- lib/classes/admission/UserFilter.class.php
