Class HttpApiV2Controller
Contains common functionality for all the GX2 APIv2 controllers. You can use the $api instance in the child-controllers in order to gain access to request and response information. The $uri variable is an array that contains the requested resource path.
You can use a protected "__initialize" method in your child controllers for performing common operations without overriding the parent constructor method.
This class contains some private methods that define the core operations of each controller and should not be called from a child-controller (like validation, authorization, rate limiting). The only way to disable the execution of these methods is to override the controller.
| package |
Default |
|---|
__construct(\Slim\Slim $api, array $uri)
Call this constructor from every child controller class in order to set the Slim instance and the request routes arguments to the class.
| deprecated |
The "__initialize" method will is deprecated and will be removed in a future version. Please use the new "init" for bootstrapping your child API controllers. |
|---|---|
| Throws |
|
\Slim\SlimSlim framework instance, used for request/response manipulation.
arrayThis array contains all the segments of the current request, starting from the resource.
__initialize()
_deserializeOrderStatus(array $data) : \OrderStatus
arrayOrder status object to be deserialized.
\OrderStatusDeserialized order status data.
_linkResponse(array &$response)
The APIv2 operates with simple resources that might be linked with other resources. This architecture promotes flexibility so that API consumers can have a simpler structure. This method will search for existing external resources and will add a link to the end of each resource.
IMPORTANT: If for some reason you need to include custom links to your resources do not use this method. Include them inside your controller method manually.
NOTICE #1: This method will only search at the first level of the resource. That means that nested ID values will not be taken into concern.
NOTICE #2: You can provide both associative (single response item) or sequential (multiple response items) arrays and this method will adjust the links accordingly.
arrayPassed by reference, new links will be appended into the end of each resource.
_locateResource(string $p_name, integer $p_id)
Use this method whenever you want the "Location" header to point to an existing resource so that clients can use it to fetch that resource without having to generate the URL themselves.
| Throws |
|
|---|
string
integer
_mapResponse(array $criteria) : boolean
Some API resources contain many subresources which makes the creation of a single controller class complicated and hard to maintain. This method will forward the request to a another controller by checking the provided criteria.
Example:
$criteria = array( 'items' => 'OrdersItemsAttributesApiV2Controller', 'totals' => 'OrdersTotalsApiV2Controller' );
Notice: Each controller should map a direct subresource and not deeper ones. This way every API controller is responsible to map its direct subresources.
| Throws |
|
|---|
arrayAn array containing the mapping criteria.
booleanReturns whether the request was eventually mapped.
_minimizeResponse(array &$response)
APIv2 supports the GET "fields" parameter which enables the client to select the exact fields to be included in the response. It does not support nested fields, only first-level.
You can provide both associative (single response item) or sequential (multiple response items) arrays and this method will adjust the links accordingly.
arrayPassed by reference, it will be minified to the required fields.
_paginateResponse(array &$response, integer $p_totalItemCount = null)
One of the common functionalities of the APIv2 is the pagination and this can be easily achieved by this function which will update the response with the records that need to be returned. This method will automatically set the pagination headers in the response so that client apps can easily navigate through results.
arrayPassed by reference, it will be paginated according to the provided parameters.
integer|null Optionally set the total number of resources.
_prepareResponse()
This method will prepare default attributes of the API responses. Further response settings must be set explicitly from each controller method separately.
Not available to child-controllers (private method).
_searchResponse(array &$response, string $p_keyword)
Normally the best way to filter the results is through the corresponding service but some times there is not specific method for searching the requested resource or subresource. When this is the case use this method to filter the results of the response before returning them back to the client.
| Throws |
|
|---|
arrayContains the response data to be written.
stringThe keyword to be used for the search.
_serializeOrderStatus(\OrderStatus $orderStatus) : array
arraySerialized order status data.
_serializeOrderStatusCollection(\OrderStatusCollection $collection) : array
arraySerialized order status collection data.
_setJsonValue(string $jsonString, string $property, string $value) : string
stringThe json formatted string which should be updated.
stringThe name or key of the property which should be updated.
stringThe new value which should be set.
stringThe updated json formatted string.
_setPaginationHeader(integer $p_currentPage, integer $p_itemsPerPage, integer $p_totalItemCount)
Useful for GET responses that return multiple items to the client. The client can use the links to navigate through the records without having to construct them on its own.
| link |
Not available to child-controllers (private method). |
|---|---|
| Throws |
|
integerCurrent request page number.
integerThe number of items to be returned in each page.
integerTotal number of the resource items.
_setRateLimitHeader()
There is a cache file that will store each user session and provide a security mechanism that will protect the shop from DOS attacks or service overuse. Each session will use the hashed "Authorization header" to identify the client. When the limit is reached a "HTTP/1.1 429 Too Many Requests" will be returned.
Headers: X-Rate-Limit-Limit >> Max number of requests allowed. X-Rate-Limit-Remaining >> Number of requests remaining. X-Rate-Limit-Reset >> UTC epoch seconds until the limit is reset.
Important: This method will be executed in every API call and it might slow the response time due to filesystem operations. If the difference is significant then it should be optimized.
Not available to child-controllers (private method).
| Throws |
|
|---|
_sortResponse(array &$response)
This method supports nested sort values, so by providing a "+address.street" value to the "sort" GET parameter the records will be sort by street value in ascending order. Method supports sorting up to 5 fields.
Important #1: This method has some advantages and disadvantages over the classic database sort mechanism. First it does not need mapping between the API fields and the database fields. Second it does not depend on external system code to sort the response items, so if for example a domain-service does not support sorting the result can still be sorted before sent to the client. The disadvantages are that it will only support a predefined number of fields and this is a trade-off because the method should not use the "eval" function, which will introduce security risks. Furthermore it might be a bit slower than the database sorting.
Important #2: This method is using PHP's array_multisort which by default will sort strings in a case sensitive manner. That means that strings starting with a capital letter will come before strings starting with a lowercase letter. http://php.net/manual/en/function.array-multisort.php
Example: // will sort ascending by customer ID and descending by customer company api.php/v2/customers?sort=+id,-address.company
arrayPassed by reference, contains an array of the multiple items that will returned as a response to the client.
_validateRequest()
This method will validate the request headers, user authentication and other parameters before the controller proceeds with the response.
Not available to child-controllers (private method).
| Throws |
|
|---|
_writeResponse(array $response, integer $p_statusCode = 200)
Use this method to write a JSON encoded, pretty printed and unescaped response to the client consumer. It is very important that the API provides pretty printed responses because it is easier for users to debug and develop.
IMPORTANT: PHP v5.3 does not support the JSON_PRETTY_PRINT and JSON_UNESCAPED_SLASHES so this method will check for their existance and then use them if possible.
arrayContains the response data to be written.
integer(optional) Provide a custom status code for the response, default 200 - Success.
delete()
| apiVersion |
2.4.0 |
|---|---|
| apiName |
DeleteOrderStatus |
| apiGroup |
OrderStatus |
| apiDescription |
Removes a order status record from the system. This method will always return success. |
| apiExample |
{curl} Delete Order Status with ID = 2 curl -X DELETE --user admin@shop.de:12345 http://shop.de/api.php/v2/order_statuses/2 |
| apiSuccessExample |
{json} Success-Response { "code": 200, "status": "success", "action": "delete", "orderStatusId": 2 } |
get()
| apiVersion |
2.4.0 |
|---|---|
| apiName |
GetOrderStatus |
| apiGroup |
OrderStatus |
| apiDescription |
Get a single order status entry. This method is currently limited to only fetching a single order status resource so make sure that you provide the order status ID in the request URI. |
| apiExample |
{curl} Get all order statuses curl --user admin@shop.de:12345 http://shop.de/api.php/v2/order_statuses {curl} Get order status with ID = 2 curl --user admin@shop.de:12345 http://shop.de/api.php/v2/order_statuses/2 |
| apiSuccess |
Response-Body If successful, this method will return the order status resource in JSON format. |
| apiError |
(Error 5xx) 500-InternalError If the record is not found or something else goes wrong the API will return a 500 error status. Read the message for more info. (Error 4xx) 400-Bad Request If the ID is not numeric in the request URI then the API will return a 400 error status because it cannot return the order status resource. |
post()
| apiVersion |
2.4.0 |
|---|---|
| apiName |
CreateOrderStatus |
| apiGroup |
OrderStatus |
| apiDescription |
This method creates a new order status in the database. |
| apiExample |
{curl} Creates New Order Status curl -X POST --user admin@shop.de:12345 http://shop.de/api.php/v2/order_statuses |
| apiParamExample |
{json} Create new order status { "names": { "EN": "new order status name", "DE": "neuer order status name" }, "color": "adad1313" } |
| apiParam |
{object} names Language related order status names. Provide the language id as object key. {string} color Label color of order status. |
| apiSuccess |
(Success 201) Response-Body If successful, this method returns the created order status resource in the response body. |
| apiError |
400-Bad Request The API will return this status code if the order status data was not provided. |
put()
| apiVersion |
2.4.0 |
|---|---|
| apiName |
UpdateOrderStatus |
| apiGroup |
OrderStatus |
| apiDescription |
This method updates a order status in the database. |
| apiExample |
{curl} Update Order Status with ID = 2 curl -X PUT --user admin@shop.de:12345 http://shop.de/api.php/v2/order_statuses/2 |
| apiParamExample |
{json} Create new order status { "names": { "EN": "updated order status name", "DE": "aktualisierter order status name" }, "color": "adad1313" } |
| apiParam |
{object} names Language related order status names. Provide the language id as object key. {string} color Label color of order status. |
| apiSuccess |
(Success 201) Response-Body If successful, this method returns the updated order status resource in the response body. |
| apiError |
400-Bad Request The API will return this status code if the order status data or order status id was not provided. |
DEFAULT_PAGE_ITEMS
| var |
|---|
DEFAULT_CONTROLLER_NAME
| var |
|---|
DEFAULT_RATE_LIMIT
| var |
|---|
DEFAULT_RATE_RESET_PERIOD
| var |
|---|
orderStatusService : \OrderStatusServiceInterface
api : \Slim\Slim
| var |
|---|
\Slim\Slim
uri : array
Example: URI - api.php/v2/customers/73/addresses CODE - $this->uri[1]; // will return '73'
| var |
|---|
array