Institute Class Reference

Inheritance diagram for Institute:

Public Member Functions
	getId ($institute)
	getAttributes ($institute, ContextInterface $context)
	getRelationships ($resource, ContextInterface $context)
	hasResourceMeta ($resource)
	getResourceMeta ($resource)
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 = 'institutes'
const	REL_BLUBBER = 'blubber-threads'
const	REL_FACULTY = 'faculty'
const	REL_FILES = 'file-refs'
const	REL_FOLDERS = 'folders'
const	REL_MEMBERSHIPS = 'memberships'
const	REL_STATUS_GROUPS = 'status-groups'
const	REL_SUB_INSTITUTES = 'sub-institutes'
Data Fields inherited from SchemaProvider
const	TYPE = ''

Additional Inherited Members
Protected Attributes inherited from SchemaProvider
	$schemaContainer
	$currentUser

Member Function Documentation

getAttributes()

getAttributes	(		$institute,
		ContextInterface	$context
	)

Parameters

\Institute

$institute

getId()

getId

(

$institute

)

Parameters

\Institute

$institute

getRelationships()

getRelationships	(		$resource,
		ContextInterface	$context
	)

Parameters

\Institute

$resource

(PHPMD.UnusedFormalParameter)

getResourceMeta()

getResourceMeta

(

$resource

)

Parameters

\Institute

$resource

hasResourceMeta()

hasResourceMeta

(

$resource

)

Field Documentation

REL_BLUBBER

const REL_BLUBBER = 'blubber-threads'

REL_FACULTY

const REL_FACULTY = 'faculty'

REL_FILES

const REL_FILES = 'file-refs'

REL_FOLDERS

const REL_FOLDERS = 'folders'

REL_MEMBERSHIPS

const REL_MEMBERSHIPS = 'memberships'

REL_STATUS_GROUPS

const REL_STATUS_GROUPS = 'status-groups'

REL_SUB_INSTITUTES

const REL_SUB_INSTITUTES = 'sub-institutes'

TYPE

const TYPE = 'institutes'

---

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

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