Instance Class Reference

Inheritance diagram for Instance:

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	TYPE = 'courseware-instances'
const	REL_BOOKMARKS = 'bookmarks'
const	REL_ROOT = 'root'
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
	)

{}

Parameters

\Courseware\Instance

$resource

getId()

getId

(

$resource

)

{}

getRelationships()

getRelationships	(		$resource,
		ContextInterface	$context
	)

{}

Field Documentation

REL_BOOKMARKS

const REL_BOOKMARKS = 'bookmarks'

REL_ROOT

const REL_ROOT = 'root'

TYPE

const TYPE = 'courseware-instances'

---

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

• lib/classes/JsonApi/Schemas/Courseware/Instance.php