Module Class Reference

Inheritance diagram for Module:

Public Member Functions
	getId ($resource)
	getAttributes ($resource, ContextInterface $context)
	getRelationships ($resource, 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	REL_DEPARTMENTS = 'departments'
const	REL_RESPONSIBLE_DEPARTMENT = 'responsible-department'
const	REL_SOURCE_MODULE = 'source-module'
const	REL_VARIANT_MODULE = 'variant-module'
const	REL_START_SEMESTER = 'start-semester'
const	REL_END_SEMESTER = 'end-semester'
const	REL_MODULE_COMPONENTS = 'module-components'
const	REL_LANGUAGES = 'languages'
const	TYPE = 'modules'
Data Fields inherited from SchemaProvider
const	TYPE = ''

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

Member Function Documentation

getAttributes()

getAttributes	(		$resource,
		ContextInterface	$context
	)

getId()

getId

(

$resource

)

getRelationships()

getRelationships	(		$resource,
		ContextInterface	$context
	)

Field Documentation

REL_DEPARTMENTS

const REL_DEPARTMENTS = 'departments'

REL_END_SEMESTER

const REL_END_SEMESTER = 'end-semester'

REL_LANGUAGES

const REL_LANGUAGES = 'languages'

REL_MODULE_COMPONENTS

const REL_MODULE_COMPONENTS = 'module-components'

REL_RESPONSIBLE_DEPARTMENT

const REL_RESPONSIBLE_DEPARTMENT = 'responsible-department'

REL_SOURCE_MODULE

const REL_SOURCE_MODULE = 'source-module'

REL_START_SEMESTER

const REL_START_SEMESTER = 'start-semester'

REL_VARIANT_MODULE

const REL_VARIANT_MODULE = 'variant-module'

TYPE

const TYPE = 'modules'

---

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

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