Course Class Reference

Inheritance diagram for Course:

Public Member Functions
	getId ($course)
	getAttributes ($course, ContextInterface $context)
	getRelationships ($course, 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 = 'courses'
const	REL_BLUBBER = 'blubber-threads'
const	REL_COURSEWARE = 'courseware'
const	REL_END_SEMESTER = 'end-semester'
const	REL_EVENTS = 'events'
const	REL_FEEDBACK = 'feedback-elements'
const	REL_FILES = 'file-refs'
const	REL_FOLDERS = 'folders'
const	REL_FORUM_CATEGORIES = 'forum-categories'
const	REL_INSTITUTE = 'institute'
const	REL_MEMBERSHIPS = 'memberships'
const	REL_NEWS = 'news'
const	REL_PARTICIPATING_INSTITUTES = 'participating-institutes'
const	REL_SEM_CLASS = 'sem-class'
const	REL_SEM_TYPE = 'sem-type'
const	REL_START_SEMESTER = 'start-semester'
const	REL_STATUS_GROUPS = 'status-groups'
const	REL_WIKI_PAGES = 'wiki-pages'
const	REL_TOOLS = 'tools'
Data Fields inherited from SchemaProvider
const	TYPE = ''

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

Member Function Documentation

getAttributes()

getAttributes	(		$course,
		ContextInterface	$context
	)

getId()

getId

(

$course

)

getRelationships()

getRelationships	(		$course,
		ContextInterface	$context
	)

getResourceMeta()

getResourceMeta

(

$resource

)

Parameters

\Course

$resource

hasResourceMeta()

hasResourceMeta

(

$resource

)

Field Documentation

REL_BLUBBER

const REL_BLUBBER = 'blubber-threads'

REL_COURSEWARE

const REL_COURSEWARE = 'courseware'

REL_END_SEMESTER

const REL_END_SEMESTER = 'end-semester'

REL_EVENTS

const REL_EVENTS = 'events'

REL_FEEDBACK

const REL_FEEDBACK = 'feedback-elements'

REL_FILES

const REL_FILES = 'file-refs'

REL_FOLDERS

const REL_FOLDERS = 'folders'

REL_FORUM_CATEGORIES

const REL_FORUM_CATEGORIES = 'forum-categories'

REL_INSTITUTE

const REL_INSTITUTE = 'institute'

REL_MEMBERSHIPS

const REL_MEMBERSHIPS = 'memberships'

REL_NEWS

const REL_NEWS = 'news'

REL_PARTICIPATING_INSTITUTES

const REL_PARTICIPATING_INSTITUTES = 'participating-institutes'

REL_SEM_CLASS

const REL_SEM_CLASS = 'sem-class'

REL_SEM_TYPE

const REL_SEM_TYPE = 'sem-type'

REL_START_SEMESTER

const REL_START_SEMESTER = 'start-semester'

REL_STATUS_GROUPS

const REL_STATUS_GROUPS = 'status-groups'

REL_TOOLS

const REL_TOOLS = 'tools'

REL_WIKI_PAGES

const REL_WIKI_PAGES = 'wiki-pages'

TYPE

const TYPE = 'courses'

---

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

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