Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
RelationshipsController Class Reference
Inheritance diagram for RelationshipsController:
JsonApiController Mentions Memberships BlocksEditBlocker BlocksFilerefs BookmarkedStructuralElements ContainersBlocks ContainersEditBlocker StructuralElementsChildren StructuralElementsContainers StructuralElementsEditBlocker UsersBookmarkedStructuralElements FileRefsOfFile TermsOfFileRef Ranges Contacts ParentPage

Public Member Functions

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

Protected Member Functions

 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 JsonApiController
 $app
 
 $container
 
 $factory
 
 $encoder
 
 $schemaContainer
 
 $queryParser
 
 $allowUnrecognizedParams = false
 
 $allowedIncludePaths = []
 
 $allowedFieldSetTypes = null
 
 $allowedSortFields = []
 
 $allowedPagingParameters = []
 
 $allowedFilteringParameters = []
 

Member Function Documentation

__invoke ( Request  $request,
Response  $response,
  $args 
)

(PHPMD.UnusedFormalParameter)

addToRelationship ( Request  $request,
  $related 
)
protected

(PHPMD.UnusedFormalParameter)

authorize ( Request  $request,
  $resource 
)
abstractprotected
fetchRelationship ( Request  $request,
  $related 
)
protected

(PHPMD.UnusedFormalParameter)

findRelated ( array  $args)
abstractprotected
getRelationshipLinks (   $resource,
  $userData = null 
)
protected
getRelationshipRelatedLink (   $resource,
  $schema,
  $userData 
)
abstractprotected
getRelationshipSelfLink (   $resource,
  $schema,
  $userData 
)
abstractprotected
removeFromRelationship ( Request  $request,
  $related 
)
protected

(PHPMD.UnusedFormalParameter)

replaceRelationship ( Request  $request,
  $related 
)
protected

(PHPMD.UnusedFormalParameter)

validateResourceDocument (   $json,
  $data 
)
protected

(PHPMD.UnusedFormalParameter)

Field Documentation

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

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