User Class Reference

Inheritance diagram for User:

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)
	getAllowedAncludePaths (ContextInterface $context)

Data Fields
const	TYPE = 'users'
const	REL_ACTIVITYSTREAM = 'activitystream'
const	REL_BLUBBER = 'blubber-threads'
const	REL_BLUBBER_DEFAULT_THREAD = 'blubber-default-thread'
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()

getAttributes	(		$user,
		ContextInterface	$context
	)

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

getId()

getId

(

$user

)

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

getRelationships()

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()

getResourceMeta

(

$resource

)

{}

hasResourceMeta()

hasResourceMeta

(

$resource

)

Field Documentation

REL_ACTIVITYSTREAM

const REL_ACTIVITYSTREAM = 'activitystream'

REL_BLUBBER

const REL_BLUBBER = 'blubber-threads'

REL_BLUBBER_DEFAULT_THREAD

const REL_BLUBBER_DEFAULT_THREAD = 'blubber-default-thread'

REL_CONFIG_VALUES

const REL_CONFIG_VALUES = 'config-values'

REL_CONTACTS

const REL_CONTACTS = 'contacts'

REL_COURSE_MEMBERSHIPS

const REL_COURSE_MEMBERSHIPS = 'course-memberships'

REL_COURSES

const REL_COURSES = 'courses'

REL_COURSEWARE_BOOKMARKS

const REL_COURSEWARE_BOOKMARKS = 'courseware-bookmarks'

REL_EVENTS

const REL_EVENTS = 'events'

REL_FILES

const REL_FILES = 'file-refs'

REL_FOLDERS

const REL_FOLDERS = 'folders'

REL_INBOX

const REL_INBOX = 'inbox'

REL_INSTITUTE_MEMBERSHIPS

const REL_INSTITUTE_MEMBERSHIPS = 'institute-memberships'

REL_NEWS

const REL_NEWS = 'news'

REL_OUTBOX

const REL_OUTBOX = 'outbox'

REL_SCHEDULE

const REL_SCHEDULE = 'schedule'

TYPE

const TYPE = 'users'

---

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

• lib/classes/JsonApi/Schemas/User.php