Class AbstractApiV2Controller

This class defines the inner core functionality of a ApiV2Controller. It contains the initialization and request validation functionality that every controller must have.

The functionality of this class is mark as private because child controllers must not alter the state at this point but rather adjust to it. This will force them to follow the same principles and methodologies.

Direct known subclasses

HttpApiV2Controller

Indirect known subclasses

Abstract
Package: ApiV2Controllers
Category: System
Located at SystemServices/Http/AbstractApiV2Controller.inc.php

Methods summary

`public`	# `__construct( Slim\Slim $api, array $uri )` HttpApiV2Controller Constructor HttpApiV2Controller Constructor Call this constructor from every child controller class in order to set the Slim instance and the request routes arguments to the class. Parameters `$api` Slim framework instance, used for request/response manipulation. `$uri` This array contains all the segments of the current request, starting from the resource. Throws `HttpApiV2Exception` Through _validateRequest

Constants summary

`integer`	`DEFAULT_PAGE_ITEMS` Defines the default page offset for responses that return multiple items. Defines the default page offset for responses that return multiple items.	# `50`
`string`	`DEFAULT_CONTROLLER_NAME` Default controller to be loaded when no resource was selected. Default controller to be loaded when no resource was selected.	# `'DefaultApiV2Controller'`
`integer`	`DEFAULT_RATE_LIMIT` Defines the maximum request limit for an authorized client. Defines the maximum request limit for an authorized client.	# `5000`
`integer`	`DEFAULT_RATE_RESET_PERIOD` Defines the duration of an API session in minutes. Defines the duration of an API session in minutes.	# `15`

Properties summary

`protected Slim\Slim`	`$api` Slim Framework instance is used to manipulate the request or response data. Slim Framework instance is used to manipulate the request or response data.	#
`protected array`	`$uri` Contains the request URI segments after the root api version segment. Contains the request URI segments after the root api version segment. Example: URI - api.php/v2/customers/73/addresses CODE - $this->uri[1]; // will return '73'	#

Packages

Classes