Oihana PHP System

CborTrait

Provides utility methods for managing Cbor encoding options and creating standardized JSON HTTP responses within controllers.

Table of Contents

Properties

$cborSerializeOptions  : array<string|int, mixed>
Temporary serialization options.

Methods

cborResponse()  : ResponseInterface
Return a cbor response
initializeCborOptions()  : static
Initialize the internal $cborSerializeOptions property.

Properties

$cborSerializeOptions

Temporary serialization options.

public array<string|int, mixed> $cborSerializeOptions = [\oihana\core\options\ArrayOption::REDUCE => true]

(ex: ArrayOption::REDUCE, custom schema flags, etc.)

Methods

cborResponse()

Return a cbor response

public cborResponse(ResponseInterface $response[, mixed $data = null ][, int $status = HttpStatusCode::OK ]) : ResponseInterface
Parameters
$response : ResponseInterface
$data : mixed = null
$status : int = HttpStatusCode::OK
Return values
ResponseInterface

initializeCborOptions()

Initialize the internal $cborSerializeOptions property.

public initializeCborOptions([array<string|int, mixed> $init = [] ][, ContainerInterface|null $container = null ]) : static
Parameters
$init : array<string|int, mixed> = []
$container : ContainerInterface|null = null
Tags
throws
ContainerExceptionInterface
NotFoundExceptionInterface
Return values
static
On this page

Search results