\PrivateBinRequest

Request

parses request parameters and provides helper functions for routing

Summary

Methods
Properties
Constants
__construct()
getOperation()
getParam()
getRequestUri()
isJsonApiCall()
setInputStream()
No public properties found
MIME_JSON
MIME_HTML
MIME_XHTML
No protected methods found
No protected properties found
N/A
_detectJsonRequest()
$_inputStream
$_operation
$_params
$_isJsonApi
N/A

Constants

MIME_JSON

MIME_JSON

MIME type for JSON

MIME_HTML

MIME_HTML

MIME type for HTML

MIME_XHTML

MIME_XHTML

MIME type for XHTML

Properties

$_inputStream

$_inputStream : string

Input stream to use for PUT parameter parsing

Type

string

$_operation

$_operation : string

Operation to perform

Type

string

$_params

$_params : array

Request parameters

Type

array

$_isJsonApi

$_isJsonApi : boolean

If we are in a JSON API context

Type

boolean

Methods

__construct()

__construct() 

Constructor

getOperation()

getOperation() : string

Get current operation

Returns

string

getParam()

getParam(string  $param, string  $default = '') : string

Get a request parameter

Parameters

string $param
string $default

Returns

string

getRequestUri()

getRequestUri() : string

Get request URI

Returns

string

isJsonApiCall()

isJsonApiCall() : boolean

If we are in a JSON API context

Returns

boolean

setInputStream()

setInputStream(string  $input) 

Override the default input stream source, used for unit testing

Parameters

string $input