Context Class Reference

Inheritance diagram for Context:

Public Member Functions
	getRangeId ()
	getContextType ()
	getContextFullname ($format='default')
	getObserver ()
	getActivities (Filter $filter)

Data Fields
	$observer

Static Public Attributes
static	$objectTypes
static	$contexTypes

Protected Member Functions
	getProvider ()
	addProvider ($class_name)
	filterProvider ($providers, Filter $filter)

Protected Attributes
	$provider

Member Function Documentation

addProvider()

addProvider (   $class_name )

protected

Add a provider to this context

Parameters

string	$provider	the name for the provider
string	$class_name	the class that belongs to the provider

filterProvider()

filterProvider (   $providers, Filter  $filter  )

protected

Filter the passed the providers to match the passed filter

Parameters

type	$providers
\Studip\Activity\Filter	$filter

Returns

type

getActivities()

getActivities

(

Filter

$filter

)

get list of activities as array for the current context

Parameters

\Studip\Activity\Filter

$filter

Returns

array

getContextFullname()

getContextFullname (   $format = 'default' )

abstract

get type of context (f.e. user, system, course, institute, ...)

Returns

string

getContextType()

getContextType ( )

abstract

get type of context (f.e. user, system, course, institute, ...)

Returns

string

getObserver()

getObserver

(

)

Return user for who wants to watch his and related activities

Returns

object a user object

getProvider()

getProvider ( )

abstractprotected

return array, listing all active providers in this context

Returns

array

getRangeId()

getRangeId ( )

abstract

get id denoting the context (user_id, course_id, institute_id, ...)

Returns

string

Field Documentation

$contexTypes

$contexTypes

static

Initial value:

= [
        'system',
        'course',
        'institute',
        'user'
    ]

$objectTypes

$objectTypes

static

Initial value:

= [
        'documents',
        'message',
        'news',
        'participants',
        'schedule',
        'wiki',
        'courseware',
        'forum'
    ]

$observer

$observer

$provider

$provider

protected

---

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

• lib/activities/Context.php