ForumCategory Class Reference

Inheritance diagram for ForumCategory:

Public Member Functions
	getId ($category)
	getAttributes ($category, ContextInterface $context)
	getRelationships ($category, ContextInterface $context)
	addCourseRelationship ($category, $isPrimary, $includeList)
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 = 'forum-categories'
const	REL_COURSE = 'course'
const	REL_ENTRY = 'entries'
Data Fields inherited from SchemaProvider
const	TYPE = ''

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

Member Function Documentation

addCourseRelationship()

addCourseRelationship	(		$category,
			$isPrimary,
			$includeList
	)

getAttributes()

getAttributes	(		$category,
		ContextInterface	$context
	)

getId()

getId

(

$category

)

getRelationships()

getRelationships	(		$category,
		ContextInterface	$context
	)

Field Documentation

REL_COURSE

const REL_COURSE = 'course'

REL_ENTRY

const REL_ENTRY = 'entries'

TYPE

const TYPE = 'forum-categories'

---

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

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