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

Public Member Functions

 getId ($user)
 
 getAttributes ($user, ContextInterface $context)
 
 hasResourceMeta ($resource)
 
 getResourceMeta ($resource)
 
 getRelationships ($user, 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)
 

Data Fields

const TYPE = 'users'
 
const REL_ACTIVITYSTREAM = 'activitystream'
 
const REL_BLUBBER = 'blubber-threads'
 
const REL_CONFIG_VALUES = 'config-values'
 
const REL_CONTACTS = 'contacts'
 
const REL_COURSES = 'courses'
 
const REL_COURSE_MEMBERSHIPS = 'course-memberships'
 
const REL_COURSEWARE_BOOKMARKS = 'courseware-bookmarks'
 
const REL_EVENTS = 'events'
 
const REL_FILES = 'file-refs'
 
const REL_FOLDERS = 'folders'
 
const REL_INBOX = 'inbox'
 
const REL_INSTITUTE_MEMBERSHIPS = 'institute-memberships'
 
const REL_NEWS = 'news'
 
const REL_OUTBOX = 'outbox'
 
const REL_SCHEDULE = 'schedule'
 
- Data Fields inherited from SchemaProvider
const TYPE = ''
 

Additional Inherited Members

- Protected Attributes inherited from SchemaProvider
 $schemaContainer
 
 $currentUser
 

Member Function Documentation

getAttributes (   $user,
ContextInterface  $context 
)

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

getId (   $user)

Diese Method entscheidet über die JSON-API-spezifische ID von -Objekten. {}

getRelationships (   $user,
ContextInterface  $context 
)

In dieser Methode können Relationships zu anderen Objekten spezifiziert werden. In diesem Beispiel kleben die Kontakte eines Nutzers bei Bedarf am . {}

getResourceMeta (   $resource)

{}

hasResourceMeta (   $resource)

Field Documentation

const REL_ACTIVITYSTREAM = 'activitystream'
const REL_BLUBBER = 'blubber-threads'
const REL_CONFIG_VALUES = 'config-values'
const REL_CONTACTS = 'contacts'
const REL_COURSE_MEMBERSHIPS = 'course-memberships'
const REL_COURSES = 'courses'
const REL_COURSEWARE_BOOKMARKS = 'courseware-bookmarks'
const REL_EVENTS = 'events'
const REL_FILES = 'file-refs'
const REL_FOLDERS = 'folders'
const REL_INBOX = 'inbox'
const REL_INSTITUTE_MEMBERSHIPS = 'institute-memberships'
const REL_NEWS = 'news'
const REL_OUTBOX = 'outbox'
const REL_SCHEDULE = 'schedule'
const TYPE = 'users'

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