StructuralElement Class Reference

Inheritance diagram for StructuralElement:

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-structural-elements'
const	REL_ANCESTORS = 'ancestors'
const	REL_CHILDREN = 'children'
const	REL_CONTAINERS = 'containers'
const	REL_COURSE = 'course'
const	REL_DESCENDANTS = 'descendants'
const	REL_EDITBLOCKER = 'edit-blocker'
const	REL_EDITOR = 'editor'
const	REL_IMAGE = 'image'
const	REL_OWNER = 'owner'
const	REL_PARENT = 'parent'
const	REL_USER = 'user'
const	REL_TASK = 'task'
const	REL_UNIT = 'unit'
const	REL_FEEDBACKELEMENT = 'feedback-element'
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
	)

{}

Parameters

StructuralElement	$resource
ContextInterface	$context

Field Documentation

REL_ANCESTORS

const REL_ANCESTORS = 'ancestors'

REL_CHILDREN

const REL_CHILDREN = 'children'

REL_CONTAINERS

const REL_CONTAINERS = 'containers'

REL_COURSE

const REL_COURSE = 'course'

REL_DESCENDANTS

const REL_DESCENDANTS = 'descendants'

REL_EDITBLOCKER

const REL_EDITBLOCKER = 'edit-blocker'

REL_EDITOR

const REL_EDITOR = 'editor'

REL_FEEDBACKELEMENT

const REL_FEEDBACKELEMENT = 'feedback-element'

REL_IMAGE

const REL_IMAGE = 'image'

REL_OWNER

const REL_OWNER = 'owner'

REL_PARENT

const REL_PARENT = 'parent'

REL_TASK

const REL_TASK = 'task'

REL_UNIT

const REL_UNIT = 'unit'

REL_USER

const REL_USER = 'user'

TYPE

const TYPE = 'courseware-structural-elements'

---

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

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