UserLookup Class Reference

Collaboration diagram for UserLookup:

Public Member Functions
	setFilter ($type, $value)
	execute ($flags=null)
	clearFilters ()

Static Public Member Functions
static	addType ($name, $values_callback, $filter_callback)
static	getValuesForType ($type)

Data Fields
const	USE_CACHE = false
const	CACHE_DURATION = 3600
const	FLAG_SORT_NAME = 1
const	FLAG_RETURN_FULL_INFO = 2
const	USE_COMBINED_STUDYGROUP_FILTER = 'use-combined-studygroup-filter'

Protected Member Functions
	getFilters ()

Static Protected Member Functions
static	fachValues ()
static	abschlussValues ()
static	fachsemesterValues ()
static	institutFilter ($needles)
static	institutValues ()
static	statusFilter ($needles)
static	statusValues ()
static	domainFilter ($needles)
static	domainValues ()

Static Protected Attributes
static	$types

Member Function Documentation

abschlussValues()

static abschlussValues ( )

staticprotected

Return all studydegrees

Returns

array Associative array of abschluss ids and abschluss names

Here is the call graph for this function:

addType()

static addType (   $name,   $values_callback,   $filter_callback  )

static

Adds or updates a filter criterion the global set of criteria.

Parameters

string	$name	Name of the criterion type
callback	$values_callback	Callback for the type's values
callback	$filter_callback	Actual filter callback for a defined set of needles

clearFilters()

clearFilters

(

)

Clears all defined filters.

Returns

UserLookup Returns itself to allow chaining

domainFilter()

static domainFilter (   $needles )

staticprotected

Return all users with a matching domain given in $needles

Parameters

array

$needles

List of domain ids to filter against

Returns

array List of user ids matching the given filter

Here is the call graph for this function:

domainValues()

static domainValues ( )

staticprotected

Return all valid domains

Returns

array Associative array of domain id and name

Here is the call graph for this function:

execute()

execute

(

$flags = null

)

Executes the actual lookup by executing all individual filter types and returning the intersection of all according result sets.

Possible flags:

• FLAG_SORT_NAME Sorts the user ids in the result by the actual user names
• FLAG_RETURN_FULL_INFO Returns rudimental user info instead of just the ids (as an array with the user id as key and an array containting the info as value)

Parameters

int

$flags

Optional set of flags as seen above

Returns

array Either a simple list of user ids or an associative array of user ids and user info if FLAG_RETURN_FULL_INFO is set

Here is the call graph for this function:

fachsemesterValues()

static fachsemesterValues ( )

staticprotected

Create a array with all possible values for studysemesters

Returns

array Associative array of fachsemesters and fachsemesters (pretty dull, i know)

Here is the call graph for this function:

fachValues()

static fachValues ( )

staticprotected

Return all studycourses

Returns

array Associative array of studiengang ids and studiengang names

Here is the call graph for this function:

getFilters()

getFilters ( )

protected

Here is the caller graph for this function:

getValuesForType()

static getValuesForType (   $type )

static

Returns all valid values for a certain criterion type.

Parameters

string

$type

Name of the criterion type

Returns

array Associative array containing the values as keys and descriptive names as values

Here is the call graph for this function:

Here is the caller graph for this function:

institutFilter()

static institutFilter (   $needles )

staticprotected

Return all users with a matching institut_id given in $needles

Parameters

array

$needles

List of institut ids to filter against

Returns

array List of user ids matching the given filter

Here is the call graph for this function:

institutValues()

static institutValues ( )

staticprotected

Return all faculty's and instituts

Returns

array Associative array of institut ids and institut data (Be aware that this array is multidimensional)

Here is the call graph for this function:

setFilter()

setFilter	(		$type,
			$value
	)

Adds another type filter to the set of current filters.

Multiple filters for the same filter type result in an AND filter within this type while multiple filters across filter types result in an OR filter across these types.

Parameters

string	$type	Type of filter to add
string	$value	Value to filter against

Returns

UserLookup Returns itself to allow chaining

statusFilter()

static statusFilter (   $needles )

staticprotected

Return all users with a matching status given in $needles

Parameters

array

$needles

List of statusses to filter against

Returns

array List of user ids matching the given filter

Here is the call graph for this function:

statusValues()

static statusValues ( )

staticprotected

Return all valid statusses

Returns

array Associative array of status name and description

Field Documentation

$types

$types

staticprotected

Initial value:

= [
        'abschluss' => [
            'filter' => self::USE_COMBINED_STUDYGROUP_FILTER,
            'values' => 'UserLookup::abschlussValues',
        ],
        'fach' => [
            'filter' => self::USE_COMBINED_STUDYGROUP_FILTER,
            'values' => 'UserLookup::fachValues',
        ],
        'fachsemester' => [
            'filter' => self::USE_COMBINED_STUDYGROUP_FILTER,
            'values' => 'UserLookup::fachsemesterValues',
        ],
        'institut' => [
            'filter' => 'UserLookup::institutFilter',
            'values' => 'UserLookup::institutValues',
        ],
        'status' => [
            'filter' => 'UserLookup::statusFilter',
            'values' => 'UserLookup::statusValues',
        ],
        'domain' => [
            'filter'    =>'UserLookup::domainFilter',
            'values'    =>'UserLookup::domainValues'
        ],
    ]

CACHE_DURATION

const CACHE_DURATION = 3600

FLAG_RETURN_FULL_INFO

const FLAG_RETURN_FULL_INFO = 2

FLAG_SORT_NAME

const FLAG_SORT_NAME = 1

USE_CACHE

const USE_CACHE = false

USE_COMBINED_STUDYGROUP_FILTER

const USE_COMBINED_STUDYGROUP_FILTER = 'use-combined-studygroup-filter'

---

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

• lib/classes/UserLookup.class.php