JsonHelper

A trait that can be used by controllers who need to return typical JSON

trait JsonHelper

Copyright: 2015-2016 Appertly

License: Apache-2.0

Instance Methods

Protected
Returns	Signature and Description
`ResponseInterface`	`sendCreated`(`ResponseInterface $response`, `string $type`, `ConstVector<string> $ids`, `ConstMap<string,mixed> $extra = ImmMap{}`) Send notice that an entity was created.
`ResponseInterface`	`sendDeleted`(`ResponseInterface $response`, `string $type`, `ConstVector<string> $ids`, `ConstMap<string,mixed> $extra = ImmMap{}`) Send notice that objects were deleted.
`ResponseInterface`	`sendItems`<`T`>(`ResponseInterface $response`, `Traversable<T> $items`, `?Pagination $pagination = null`, `?int $total = null`) Sends a Content-Range header for pagination
`ResponseInterface`	`sendJson`(`ResponseInterface $response`, `mixed $payload`) Send something as JSON
`ResponseInterface`	`sendUpdated`(`ResponseInterface $response`, `string $type`, `ConstVector<string> $ids`, `ConstMap<string,mixed> $extra = ImmMap{}`) Send notice that objects were updated.
`ResponseInterface`	`sendVerb`(`string $verb`, `ResponseInterface $response`, `string $type`, `ConstVector<string> $ids`, `ConstMap<string,mixed> $extra = ImmMap{}`) Sends a generic notice that objects have been operated on

Method Details

sendCreated

protected function sendCreated(ResponseInterface $response, string $type, ConstVector<string> $ids, ConstMap<string,mixed> $extra = ImmMap{})

Send notice that an entity was created.

Parameters
Name	Type	Description
`$response`	`ResponseInterface`	The response
`$type`	`string`	The entity type
`$ids`	`ConstVector`<`string`>
`$extra`	`ConstMap`<`string`,`mixed`>

Returns
Type	Description
`ResponseInterface`	The JSON response

sendDeleted

protected function sendDeleted(ResponseInterface $response, string $type, ConstVector<string> $ids, ConstMap<string,mixed> $extra = ImmMap{})

Send notice that objects were deleted.

Parameters
Name	Type	Description
`$response`	`ResponseInterface`	The response
`$type`	`string`	The entity type
`$ids`	`ConstVector`<`string`>	The entity ids
`$extra`	`ConstMap`<`string`,`mixed`>

Returns
Type	Description
`ResponseInterface`	The JSON response

sendItems

protected function sendItems<T>(ResponseInterface $response, Traversable<T> $items, ?Pagination $pagination = null, ?int $total = null)

Sends a Content-Range header for pagination

Since: 0.6.0

Parameters
Name	Type	Description
`$response`	`ResponseInterface`	The response
`$items`	`Traversable`<`T`>
`$pagination`	`?Pagination`
`$total`	`?int`

Returns
Type	Description
`ResponseInterface`	The JSON response

sendJson

protected function sendJson(ResponseInterface $response, mixed $payload)

Send something as JSON

Parameters
Name	Type	Description
`$response`	`ResponseInterface`	The response
`$payload`	`mixed`	The object to serialize

Returns
Type	Description
`ResponseInterface`	The JSON response

sendUpdated

protected function sendUpdated(ResponseInterface $response, string $type, ConstVector<string> $ids, ConstMap<string,mixed> $extra = ImmMap{})

Send notice that objects were updated.

Parameters
Name	Type	Description
`$response`	`ResponseInterface`	The response
`$type`	`string`	The entity type
`$ids`	`ConstVector`<`string`>	The entity ids
`$extra`	`ConstMap`<`string`,`mixed`>	Any extra data to serialize

Returns
Type	Description
`ResponseInterface`	The JSON response

sendVerb

protected function sendVerb(string $verb, ResponseInterface $response, string $type, ConstVector<string> $ids, ConstMap<string,mixed> $extra = ImmMap{})

Sends a generic notice that objects have been operated on

Parameters
Name	Type	Description
`$verb`	`string`	The verb
`$response`	`ResponseInterface`	The response
`$type`	`string`	The entity type
`$ids`	`ConstVector`<`string`>	The entity ids
`$extra`	`ConstMap`<`string`,`mixed`>	Any extra data to serialize

Returns
Type	Description
`ResponseInterface`	The JSON response