Memberships Class Reference

Inheritance diagram for Memberships:

Protected Member Functions
	fetchRelationship (Request $request, $related)
	findRelated (array $args)
	authorize (Request $request, $resource)
	getRelationshipSelfLink ($resource, $schema, $userData)
	getRelationshipRelatedLink ($resource, $schema, $userData)
Protected Member Functions inherited from RelationshipsController
	findRelated (array $args)
	authorize (Request $request, $resource)
	validateResourceDocument ($json, $data)
	fetchRelationship (Request $request, $related)
	addToRelationship (Request $request, $related)
	removeFromRelationship (Request $request, $related)
	replaceRelationship (Request $request, $related)
	getRelationshipSelfLink ($resource, $schema, $userData)
	getRelationshipRelatedLink ($resource, $schema, $userData)
	getRelationshipLinks ($resource, $userData=null)
Protected Member Functions inherited from JsonApiController
	getCodeResponse (int $statusCode, array $headers=[])
	getMetaResponse ($meta, $statusCode=ResponsesInterface::HTTP_OK, array $headers=[])
	getContentResponse ( $data, $statusCode=ResponsesInterface::HTTP_OK, $links=[], $meta=[], array $headers=[])
	getIdentifiersResponse ($data, $links=[], $meta=[], array $headers=[])
	getPaginatedIdentifiersResponse ( $data, $total, $links=[], $meta=[], array $headers=[])
	getCreatedResponse ($resource, $links=[], $meta=[], array $headers=[])
	getPaginatedContentResponse ( $data, $total, $statusCode=ResponsesInterface::HTTP_OK, $links=[], $meta=[], array $headers=[])
	getQueryParameters ()
	getOffsetAndLimit ($offsetDefault=0, $limitDefault=30)
	getSchema ($resource)
	getResponses (array $links=[], array $meta=[])

Protected Attributes
	$allowedPagingParameters = ['offset', 'limit']
Protected Attributes inherited from RelationshipsController
	$allowedPagingParameters = ['offset', 'limit']
Protected Attributes inherited from JsonApiController
	$allowUnrecognizedParams = false
	$allowedIncludePaths = []
	$allowedFieldSetTypes = null
	$allowedSortFields = []
	$allowedPagingParameters = []
	$allowedFilteringParameters = []

Additional Inherited Members
Public Member Functions inherited from RelationshipsController
	__invoke (Request $request, Response $response, $args)
Public Member Functions inherited from JsonApiController
	__construct (protected \Slim\App $app, protected ContainerInterface $container, protected FactoryInterface $factory, protected EncoderInterface $encoder, protected SchemaContainerInterface $schemaContainer, protected QueryParserInterface $queryParser, protected ResponseFactoryInterface $responseFactory, HeaderParametersParserInterface $headerParametersParser)
	getUser (Request $request)

Member Function Documentation

authorize()

authorize ( Request  $request,   $resource  )

protected

fetchRelationship()

fetchRelationship ( Request  $request,   $related  )

protected

(PHPMD.UnusedFormalParameter)

findRelated()

findRelated ( array  $args )

protected

getRelationshipRelatedLink()

getRelationshipRelatedLink (   $resource,   $schema,   $userData  )

protected

(PHPMD.UnusedFormalParameter)

getRelationshipSelfLink()

getRelationshipSelfLink (   $resource,   $schema,   $userData  )

protected

(PHPMD.UnusedFormalParameter)

Field Documentation

$allowedPagingParameters

$allowedPagingParameters = ['offset', 'limit']

protected

---

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

• lib/classes/JsonApi/Routes/Courses/Rel/Memberships.php