Stud.IP  5.4
DescendantsOfStructuralElementsIndex Class Reference
Inheritance diagram for DescendantsOfStructuralElementsIndex:
JsonApiController

Protected Attributes

 $allowedPagingParameters = ['offset', 'limit']
 
 $allowedIncludePaths = ['containers', 'course', 'editor', 'owner', 'parent']
 
- Protected Attributes inherited from JsonApiController
 $app
 
 $container
 
 $factory
 
 $encoder
 
 $schemaContainer
 
 $queryParser
 
 $allowUnrecognizedParams = false
 
 $allowedIncludePaths = []
 
 $allowedFieldSetTypes = null
 
 $allowedSortFields = []
 
 $allowedPagingParameters = []
 
 $allowedFilteringParameters = []
 

Additional Inherited Members

- 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 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=[])
 

Detailed Description

Displays all descendants of a structural element.

Field Documentation

◆ $allowedIncludePaths

$allowedIncludePaths = ['containers', 'course', 'editor', 'owner', 'parent']
protected

◆ $allowedPagingParameters

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

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