CoursesIndex Class Reference

Inheritance diagram for CoursesIndex:

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

Protected Attributes
	$allowedFilteringParameters = ['q', 'fields', 'semester', 'category', 'scope_choose', 'range_choose', 'df']
	$allowedIncludePaths
	$allowedPagingParameters = ['offset', 'limit']
Protected Attributes inherited from JsonApiController
	$allowUnrecognizedParams = false
	$allowedIncludePaths = []
	$allowedFieldSetTypes = null
	$allowedSortFields = []
	$allowedPagingParameters = []
	$allowedFilteringParameters = []

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

Member Function Documentation

__invoke()

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

(PHPMD.UnusedFormalParameters)

Field Documentation

$allowedFilteringParameters

$allowedFilteringParameters = ['q', 'fields', 'semester', 'category', 'scope_choose', 'range_choose', 'df']

protected

$allowedIncludePaths

$allowedIncludePaths

protected

Initial value:

= [
        'blubber-threads',
        'end-semester',
        'events',
        'feedback-elements',
        'file-refs',
        'folders',
        'forum-categories',
        'institute',
        'memberships',
        'news',
        'participating-institutes',
        'sem-class',
        'sem-type',
        'start-semester',
        'status-groups',
        'wiki-pages',
    ]

$allowedPagingParameters

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

protected

---

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

• lib/classes/JsonApi/Routes/Courses/CoursesIndex.php