SchemaProvider Class Reference

Inheritance diagram for SchemaProvider:

Public Member Functions
	__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 = ''

Protected Attributes
	$schemaContainer
	$currentUser

Constructor & Destructor Documentation

__construct()

__construct	(	FactoryInterface	$factory,
		SchemaContainerInterface	$schemaContainer,
		?\User	$user
	)

Member Function Documentation

createLinkToResource()

createLinkToResource

(

$resource

)

Parameters

mixed

$resource

getAllowedAncludePaths()

getAllowedAncludePaths

(

ContextInterface

$context

)

Parameters

ContextInterface

$context

Returns

array

getType()

getType

(

)

isAddRelatedLinkInRelationshipByDefault()

isAddRelatedLinkInRelationshipByDefault

(

string

$relationshipName

)

isAddSelfLinkInRelationshipByDefault()

isAddSelfLinkInRelationshipByDefault

(

string

$relationshipName

)

shouldInclude()

shouldInclude	(	ContextInterface	$context,
		string	$key
	)

Parameters

ContextInterface	$context
string	$key

Returns

bool true, if the given relationship should be included in the response

Field Documentation

$currentUser

$currentUser

protected

$schemaContainer

$schemaContainer

protected

TYPE

const TYPE = ''

---

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

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