API Documentation » \EmailsApiV2Controller

category	System
package	ApiV2Controllers

AbstractApiV2Controller Constructor

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

inherited

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	\HttpApiV2Exception Through _validateRequest

Arguments

$api

\Slim\Slim

Slim framework instance, used for request/response manipulation.

$uri

array

This array contains all the segments of the current request, starting from the resource.

Initialize controller components.

__initialize()

Get the relative URI for the mapped controller.

_getMappedControllerUri(\IntType $index, array $uri) : \the

inherited

Arguments

$index

\IntType

Contains the URI position relative to the current controller.

$uri

array

Contains the original URI

Response

\the

mapped controller URI

Initialize pager and sorters fields.

_initializePagingAndSortingFields()

inherited

One of the common functionaries of the APIv2 is the pagination and sorting. The fields initialized by this method are helpers to facilitate the access to sort and pagination information

Include links to response resources.

_linkResponse(array &$response)

inherited

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.

Arguments

$response

array

Passed by reference, new links will be appended into the end of each resource.

Add location header to a specific response.

_locateResource(string $p_name, integer $p_id)

inherited

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	\InvalidArgumentException If the arguments contain an invalid value.

Arguments

$p_name

string

$p_id

integer

Map the sub-resource to another controller.

_mapResponse(array $criteria) : boolean

inherited

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	\HttpApiV2Exception If the subresource is not supported by the API.

Arguments

$criteria

array

An array containing the mapping criteria.

Response

boolean

Returns whether the request was eventually mapped.

Minimize response using the $fields parameter.

_minimizeResponse(array &$response)

inherited

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.

Arguments

$response

array

Passed by reference, it will be minified to the required fields.

Paginate response using the $page and $per_page GET parameters.

_paginateResponse(array &$response, integer $p_totalItemCount = null)

inherited

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.

Arguments

$response

array

Passed by reference, it will be paginated according to the provided parameters.

$p_totalItemCount

integer

|null Optionally set the total number of resources.

[PRIVATE] Prepare response headers.

_prepareResponse()

inherited

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).

Perform a search on the response array.

_searchResponse(array &$response, string $p_keyword)

inherited

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	\InvalidArgumentException If search keyword parameter is not a string.

Arguments

$response

array

Contains the response data to be written.

$p_keyword

string

The keyword to be used for the search.

_setJsonValue

_setJsonValue(string $jsonString, string $property, string $value) : string

inherited

Arguments

$jsonString

string

The json formatted string which should be updated.

$property

string

The name or key of the property which should be updated.

$value

string

The new value which should be set.

Response

string

The updated json formatted string.

[PRIVATE] Set header pagination links.

_setPaginationHeader(integer $p_currentPage, integer $p_itemsPerPage, integer $p_totalItemCount)

inherited

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	http://www.w3.org/wiki/LinkHeader

Throws	\HttpApiV2Exception If one of the parameters are invalid.

Arguments

$p_currentPage

integer

Current request page number.

$p_itemsPerPage

integer

The number of items to be returned in each page.

$p_totalItemCount

integer

Total number of the resource items.

[PRIVATE] Set header pagination links.

_setPaginationHeaderByPage(\Pager $pager = null, integer $p_totalItemCount)

inherited

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	http://www.w3.org/wiki/LinkHeader

Throws	\HttpApiV2Exception If one of the parameters are invalid.

Arguments

$pager

\Pager

Pager object with pagination information

$p_totalItemCount

integer

Total number of the resource items.

[PRIVATE] Handle rate limit headers.

_setRateLimitHeader()

inherited

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	\HttpApiV2Exception If request limit exceed - 429 Too Many Requests

Sort response array with the "sort" GET parameter.

_sortResponse(array &$response)

inherited

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

Arguments

$response

array

Passed by reference, contains an array of the multiple items that will returned as a response to the client.

[PRIVATE] Validate request before proceeding with response.

_validateRequest()

inherited

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	\HttpApiV2Exception If validation fails - 415 Unsupported media type.

Write JSON encoded response data.

_writeResponse(array $response, integer $p_statusCode = 200)

inherited

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.

Arguments

$response

array

Contains the response data to be written.

$p_statusCode

integer

(optional) Provide a custom status code for the response, default 200 - Success.

delete

delete()

api

todo	Do not throw an error if a record does not exist. Because this is what other controllers do.
apiVersion	2.1.0
apiName	DeleteEmail
apiGroup	Emails
apiDescription	Delete an email record from database. To see an example usage take a look at `docs/REST/samples/email-service/remove_email.php`.
apiSuccess	Response-Body If successful this method returns information about the deleted record.
apiExample	{curl} Delete Email with ID = 572 curl -X DELETE --user admin@shop.de:12345 http://shop.de/api.php/v2/emails/572
apiSuccessExample	{json} Success-Response { "code": 200, "status": "success", "action": "delete", "emailId": 73 }
apiError	400-BadRequest The email ID parameter is missing or is not valid.

get

get()

api

apiVersion	2.1.0
apiName	GetEmails
apiGroup	Emails
apiDescription	Get multiple or a single email record through the GET method. This resource supports the following GET parameters as described in the first section of documentation: sorting minimization, search, pagination. Additionally you can filter emails by providing the GET parameter "state=pending" or "state=sent". These filter parameters do not apply when a single emails record is selected (e.g. api.php/v2/emails/84) or when the emails are searched by the "q" parameter. To see an example usage take a look at `docs/REST/samples/email-service/fetch_email.php`
apiExample	{curl} Get All Emails curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/emails {curl} Get Email With ID = 527 curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/emails/527 {curl} Get Pending Emails curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/emails?state=pending {curl} Search Emails curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/emails?q=admin@shop.de
apiError	404-NotFound Email record not found.
apiErrorExample	Error-Response HTTP/1.1 404 Not Found { "code": 404, "status": "error", "message": "Email record could not be found." }

getCallableResource

getCallableResource( $controller, array $mappedURI, \Slim\Slim $api)

inherited static

Arguments

$controller

$mappedURI

array

$api

\Slim\Slim

post

post()

api

apiVersion	2.1.0
apiName	SendEmail
apiGroup	Emails
apiDescription	This method will send and save a new or an existing email to the system. If you include mail attachments then they must already exist in the server. You will need to provide the full path to the file. To see an example usage take a look at `docs/REST/samples/email-service/send_email.php`
apiParamExample	{json} Request-Body { "subject": "Test Subject", "sender": { "emailAddress": "sender@email.de", "contactName": "John Doe" }, "recipient": { "emailAddress": "recipient@email.de", "contactName": "Jane Doe" }, "replyTo": { "emailAddress": "reply_to@email.de", "contactName": "John Doe (Reply To)" }, "contentHtml": "HTML Content", "contentPlain": "Plain Content", "bcc": [ { "emailAddress": "bcc@email.de", "contactName": "Chris Doe" } ], "cc": [ { "emailAddress": "cc@email.de", "contactName": "Chloe Doe" } ], "attachments": [ { "path": "/var/www/html/shop/uploads/attachments/1434614398/myfile.txt", "name": "Display For MyFile.txt" } ] }
apiParam	{Number} [id] If provided then an existing email will be resend (only applies to URL). {String} [subject] Email subject to be sent. {Object} sender Contains the sender contact data. {String} sender.emailAddress Sender's email address. {String} [sender.contactName] Sender display name. {Object} recipient Contains the recipient contact data. {String} recipient.emailAddress Recipient's email address. {String} [recipient.contactName] Recipient's display name. {Object} replyTo Contains the reply to contact data. {String} replyTo.emailAddress Email address of the 'Reply-To' contact. {String} replyTo.contactName Name of the 'Reply-To' contact. {String} [contentHtml] Email plain content. {String} [contentPlain] Email HTML content. {Array} [bcc] Contains the BCC contacts of the email. {Array} [cc] Contains the CC contacts of the email. {Array} [attachments] Contains the attachment data. {String} attachments[].path The path to the attachments (the file must already exist in the server). {String} [attachments[].name] Set a display name for the attachment file (must also contain the file extension).
apiSuccess	(Success 201) Response-Body If successful, this method returns a complete email resource in the response body.
apiError	400-BadRequest Email data were not provided. 404-NotFound Email record was not found.
apiErrorExample	Error-Response (400) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Email data were not provided." } Error-Response (404) HTTP/1.1 404 Not Found { "code": 404, "status": "error", "message": "Email record was not found." }

put

put()

api

apiVersion	2.1.0
apiName	QueueEmail
apiGroup	Emails
apiDescription	This method will queue a new email so that it can be send later (with the POST method). See the "post" method for parameter description. To see an example usage take a look at `docs/REST/samples/email-service/queue_email.php`
apiSuccess	(Success 200 - Email Was Queued) {String} Response-Body If successful, this method returns a complete email resource in the response body.
apiError	400-BadRequest Email data were not provided.
apiErrorExample	Error-Response HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Email data were not provided." }

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

DEFAULT_PAGE_ITEMS

inherited

var

Default controller to be loaded when no resource was selected.

DEFAULT_CONTROLLER_NAME

inherited

var

Defines the maximum request limit for an authorized client.

DEFAULT_RATE_LIMIT

inherited

var

Defines the duration of an API session in minutes.

DEFAULT_RATE_RESET_PERIOD

inherited

var

E-Mail service.

emailService : \EmailService

var

Type(s)

\EmailService

E-Mail serializer.

emailSerializer : \EmailJsonSerializer

var

Type(s)

\EmailJsonSerializer

Sorter information array.

sorters : array

inherited

var

Type(s)

array

Pagination information.

pager : \Pager

inherited

var	pager

Type(s)

\Pager

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

api : \Slim\Slim

inherited

var

Type(s)

\Slim\Slim

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

uri : array

inherited

Example: URI - api.php/v2/customers/73/addresses CODE - $this->uri[1]; // will return '73'

var

Type(s)

array

EmailsApiV2Controller

Methods

AbstractApiV2Controller Constructor

Arguments

$api

$uri

Initialize controller components.

Get the relative URI for the mapped controller.

Arguments

$index

$uri

Response

Initialize pager and sorters fields.

Include links to response resources.

Arguments

$response

Add location header to a specific response.

Arguments

$p_name

$p_id

Map the sub-resource to another controller.

Arguments

$criteria

Response

Minimize response using the $fields parameter.

Arguments

$response

Paginate response using the $page and $per_page GET parameters.

Arguments

$response

$p_totalItemCount

[PRIVATE] Prepare response headers.

Perform a search on the response array.

Arguments

$response

$p_keyword

_setJsonValue

Arguments

$jsonString

$property

$value

Response

[PRIVATE] Set header pagination links.

Arguments

$p_currentPage

$p_itemsPerPage

$p_totalItemCount

[PRIVATE] Set header pagination links.

Arguments

$pager

$p_totalItemCount

[PRIVATE] Handle rate limit headers.

Sort response array with the "sort" GET parameter.

Arguments

$response

[PRIVATE] Validate request before proceeding with response.

Write JSON encoded response data.

Arguments

$response

$p_statusCode

delete

get

getCallableResource

Arguments

$controller

$mappedURI

$api

post

put

Constants

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

Default controller to be loaded when no resource was selected.

Defines the maximum request limit for an authorized client.

Defines the duration of an API session in minutes.

Properties

E-Mail service.

Type(s)

E-Mail serializer.

Type(s)

Sorter information array.