Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
Context Class Reference
Inheritance diagram for Context:
CourseContext CoursewareContext InstituteContext SystemContext UserContext

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 (   $class_name)
protected

Add a provider to this context

Parameters
string$providerthe name for the provider
string$class_namethe class that belongs to the provider
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 ( Filter  $filter)

get list of activities as array for the current context

Parameters
\Studip\Activity\Filter$filter
Returns
array
getContextFullname (   $format = 'default')
abstract

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

Returns
string
getContextType ( )
abstract

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

Returns
string
getObserver ( )

Return user for who wants to watch his and related activities

Returns
object a user object
getProvider ( )
abstractprotected

return array, listing all active providers in this context

Returns
array
getRangeId ( )
abstract

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

Returns
string

Field Documentation

$contexTypes
static
Initial value:
= [
'system',
'course',
'institute',
'user'
]
$objectTypes
static
Initial value:
= [
'documents',
'message',
'news',
'participants',
'schedule',
'wiki',
'courseware',
'forum'
]
$observer
$provider
protected

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