Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
Activity Class Reference
Inheritance diagram for Activity:
SchemaProvider

Public Member Functions

 getId ($activity)
 
 getAttributes ($activity, ContextInterface $context)
 
 getRelationships ($activity, ContextInterface $context)
 
- Public Member Functions inherited from SchemaProvider
 __construct (FactoryInterface $factory, SchemaContainerInterface $schemaContainer,?\User $user)
 
 getType ()
 
 isAddSelfLinkInRelationshipByDefault (string $relationshipName)
 
 isAddRelatedLinkInRelationshipByDefault (string $relationshipName)
 
 createLinkToResource ($resource)
 
 shouldInclude (ContextInterface $context, string $key)
 
 getAllowedAncludePaths (ContextInterface $context)
 

Data Fields

const TYPE = 'activities'
 
const REL_ACTOR = 'actor'
 
const REL_CONTEXT = 'context'
 
const REL_OBJECT = 'object'
 
- Data Fields inherited from SchemaProvider
const TYPE = ''
 

Additional Inherited Members

- Protected Attributes inherited from SchemaProvider
 $schemaContainer
 
 $currentUser
 

Member Function Documentation

getAttributes (   $activity,
ContextInterface  $context 
)

Hier können (ausgewählte) Instanzvariablen eines -Objekts für die Ausgabe vorbereitet werden. {}

getId (   $activity)

Hier wird der Typ des Schemas festgelegt. {} Diese Method entscheidet über die JSON-API-spezifische ID von Activity-Objekten. {}

getRelationships (   $activity,
ContextInterface  $context 
)

In dieser Methode können Relationships zu anderen Objekten spezifiziert werden. {}

Field Documentation

const REL_ACTOR = 'actor'
const REL_CONTEXT = 'context'
const REL_OBJECT = 'object'
const TYPE = 'activities'

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