1. class
  2. mako
  3. \
  4. http
  5. \
  6. request
  7. \
  8. Body

Body

class Body extends Parameters

Body.

Properties

protected array $parameters Parameters. from Parameters

Methods

__construct(string $rawBody, string $contentType)

Constructor.

int
count()

Returns the numner of items in the collection.

from Parameters
ArrayIterator
getIterator()

Retruns an array iterator object.

from Parameters
add(string $name, mixed $value)

Adds a parameter.

from Parameters
bool
has(string $name)

Returns TRUE if the parameter exists and FALSE if not.

from Parameters
mixed
get(string $name, mixed $default = null)

Gets a parameter value.

from Parameters
remove(string $name)

Removes a parameter.

from Parameters
array
all()

Returns all the parameters.

from Parameters
array
whitelisted(array $keys, array $defaults = [])

Returns request data where keys not in the whitelist have been removed.

from Parameters
array
blacklisted(array $keys, array $defaults = [])

Returns request data where keys in the blacklist have been removed.

from Parameters
array
parseBody(string $rawBody, string $contentType)

Converts the request body into an associative array.

Details

at line 29
__construct(string $rawBody, string $contentType)

Constructor.

Parameters

string $rawBody Raw request body
string $contentType Content type

in Parameters at line 47
int count()

Returns the numner of items in the collection.

Return Value

int

in Parameters at line 57
ArrayIterator getIterator()

Retruns an array iterator object.

Return Value

ArrayIterator

in Parameters at line 68
add(string $name, mixed $value)

Adds a parameter.

Parameters

string $name Parameter name
mixed $value Parameter value

in Parameters at line 79
bool has(string $name)

Returns TRUE if the parameter exists and FALSE if not.

Parameters

string $name Parameter name

Return Value

bool

in Parameters at line 91
mixed get(string $name, mixed $default = null)

Gets a parameter value.

Parameters

string $name Parameter name
mixed $default Default value

Return Value

mixed

in Parameters at line 101
remove(string $name)

Removes a parameter.

Parameters

string $name Parameter name

in Parameters at line 111
array all()

Returns all the parameters.

Return Value

array

in Parameters at line 123
array whitelisted(array $keys, array $defaults = [])

Returns request data where keys not in the whitelist have been removed.

Parameters

array $keys Keys to whitelist
array $defaults Default values

Return Value

array

in Parameters at line 135
array blacklisted(array $keys, array $defaults = [])

Returns request data where keys in the blacklist have been removed.

Parameters

array $keys Keys to whitelist
array $defaults Default values

Return Value

array

at line 41
protected array parseBody(string $rawBody, string $contentType)

Converts the request body into an associative array.

Parameters

string $rawBody Raw request body
string $contentType Content type

Return Value

array