Block Class Reference

Inheritance diagram for Block:

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-blocks'
const	REL_COMMENTS = 'comments'
const	REL_CONTAINER = 'container'
const	REL_EDITBLOCKER = 'edit-blocker'
const	REL_EDITOR = 'editor'
const	REL_FEEDBACK = 'feedback'
const	REL_OWNER = 'owner'
const	REL_USERDATAFIELD = 'user-data-field'
const	REL_USERPROGRESS = 'user-progress'
const	REL_FILES = 'file-refs'
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_COMMENTS

const REL_COMMENTS = 'comments'

REL_CONTAINER

const REL_CONTAINER = 'container'

REL_EDITBLOCKER

const REL_EDITBLOCKER = 'edit-blocker'

REL_EDITOR

const REL_EDITOR = 'editor'

REL_FEEDBACK

const REL_FEEDBACK = 'feedback'

REL_FILES

const REL_FILES = 'file-refs'

REL_OWNER

const REL_OWNER = 'owner'

REL_USERDATAFIELD

const REL_USERDATAFIELD = 'user-data-field'

REL_USERPROGRESS

const REL_USERPROGRESS = 'user-progress'

TYPE

const TYPE = 'courseware-blocks'

---

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

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