API Documentation
\

\ApiBaseController

This is the base API controller class.

Summary

Methods
Properties
Constants
__construct()
getInputParams()
getResponseProvider()
setResponseProvider()
sendJson()
sendData()
$layout
$statusCode
$format
$responseProvider
No constants found
accessDenied()
No protected properties found
N/A
No private methods found
$_responseProvider
N/A

Properties

$layout

$layout

$statusCode

$statusCode

$format

$format : string

Type

string — The format in which data is sent to the user.

$responseProvider

$responseProvider : \ApiResponseProvider

Type

\ApiResponseProvider

$_responseProvider

$_responseProvider

Methods

__construct()

__construct( $id,  $module)

Parameters

$id
$module

getInputParams()

getInputParams() : array

Function fetch params from php://input.

Returns

array —

HTTP params

getResponseProvider()

getResponseProvider()

setResponseProvider()

setResponseProvider(\ApiResponseProvider $responseProvider)

Parameters

\ApiResponseProvider $responseProvider

sendJson()

sendJson(array $data, int $status, array $headers) : null

Function convert $data array to json string, sends it to client and terminates the application.

Usage example:

  $this->sendJson(
      array(...),
      200,
      array(
          "Content-Range: items $offset-$limit/$total",
          ...
      )
  );

Parameters

array $data
int $status

code.
array $headers

http headers array.

Returns

null

sendData()

sendData(array $data, integer $status, array $headers)

Function send data to end user and terminate the application.

Format of data defined based on {@link responseProvider}

Parameters

array $data

Data to be sent
integer $status

Status code (e.g. 200 or 403)
array $headers

List of additional headers to use when sending an response

accessDenied()

accessDenied() : null

Function displays "access denied" message to end users with 403 http status code and terminates the application.

Returns

null