Class AbstractApiV2Controller

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.

Child API controllers can use the "init" method to initialize their common dependencies.

Direct known subclasses

HttpApiV2Controller

Indirect known subclasses

AbstractImagesApiV2Controller, AddressesApiV2Controller, CustomersApiV2Controller, DefaultApiV2Controller, EmailsApiV2Controller, ManufacturersApiV2Controller, OrdersApiV2Controller, OrdersHistoryApiV2Controller, OrdersItemsApiV2Controller, OrdersItemsAttributesApiV2Controller, OrderStatusesApiV2Controller, OrdersTotalsApiV2Controller, AddressFormatsApiV2Controller, ProductImagesApiV2Controller, ProductReviewsApiV2Controller, ProductsApiV2Controller, ProductsLinksApiV2Controller, QuantityUnitsApiV2Controller, ReviewsApiV2Controller, ShopInformationApiV2Controller, TaxClassesApiV2Controller, TaxRatesApiV2Controller, TaxZonesApiV2Controller, AttachmentsApiV2Controller, TrackingCodeApiV2Controller, VpeApiV2Controller, WithdrawalsApiV2Controller, ZonesApiV2Controller, CacheApiV2Controller, CategoriesApiV2Controller, CategoryIconsApiV2Controller, CategoryImagesApiV2Controller, CountriesApiV2Controller, CustomerGroupsApiV2Controller

Abstract
Package: ApiV2Controllers
Category: System
Located at Controllers/Api/AbstractApiV2Controller.inc.php

Methods summary

public __construct( Slim\Slim $api, array $uri )

AbstractApiV2Controller Constructor

protected _validateRequest( void )

[PRIVATE] Validate request before proceeding with response.

protected _prepareResponse( void )

[PRIVATE] Prepare response headers.

protected _setRateLimitHeader( void )

[PRIVATE] Handle rate limit headers.

Constants summary

DEFAULT_PAGE_ITEMS : integer

Defines the default page offset for responses that return multiple items.

50
DEFAULT_CONTROLLER_NAME : string

Default controller to be loaded when no resource was selected.

'DefaultApiV2Controller'
DEFAULT_RATE_LIMIT : integer

Defines the maximum request limit for an authorized client.

5000
DEFAULT_RATE_RESET_PERIOD : integer

Defines the duration of an API session in minutes.

15

Properties summary

protected $api : Slim\Slim

Slim Framework instance is used to manipulate the request or response data.


		

		

			
			
				
				protected  
				

				
					$uri
				

				: array
			

			

				
Contains the request URI segments after the root api version segment.