JSON

JSON response class.

class JSON extends \Hazaar\Controller\Response\Response implements \ArrayAccess

This response serializes arbitrary application data into JSON for HTTP clients. It supports array/object style mutation, optional JSONP callback wrapping, and direct pass-through when pre-encoded valid JSON strings are provided.

Properties

jsonContent

Raw response payload prior to JSON serialization.

protected mixed $jsonContent

May contain arrays, objects, scalar values, or pre-encoded JSON strings.

callback

public string $callback

Methods

__construct

public __construct(mixed $data, int $status = 200): void

Parameters

Parameter	Type	Description
$data	mixed
$status	int

__set

Magic setter proxy for payload key assignment.

public __set(string $key, null $value): void

Parameters

Parameter	Type	Description
$key	string	payload key to set
$value	null	scalar value to assign

toArray

public toArray(): void

__get

Magic getter proxy for payload key retrieval.

public __get(string $key): mixed

Returns a reference to the resolved value when possible.

Parameters

Parameter	Type	Description
$key	string	payload key to read

get

Retrieve a payload value by key.

public get(string $key): mixed

Supports array-like and object-like payload containers. A null reference is returned when the key cannot be resolved.

Parameters

Parameter	Type	Description
$key	string	payload key to read

set

Set a payload value by key.

public set(string $key, mixed $value): void

Updates array-like or object-like payload containers in place.

Parameters

Parameter	Type	Description
$key	string	payload key to write
$value	mixed	value to assign

populate

public populate(array $data): void

Parameters

Parameter	Type	Description
$data	array

push

public push(array $data): void

Parameters

Parameter	Type	Description
$data	array

setCallback

Set the JSONP callback function name.

public setCallback(string $callback): void

Parameters

Parameter	Type	Description
$callback	string	javaScript callback identifier

content

Set the response payload.

public content(mixed $data): self

Parameters

Parameter	Type	Description
$data	mixed	data to be serialized as JSON

getContent

Get the final response content as JSON (or JSONP).

public getContent(): string

If the payload is already a valid JSON string, it is reused as-is; otherwise the payload is encoded with framework defaults.

hasContent

public hasContent(): bool

offsetExists

public offsetExists(mixed $offset): bool

Parameters

Parameter	Type	Description
$offset	mixed

offsetGet

public offsetGet(mixed $offset): mixed

Parameters

Parameter	Type	Description
$offset	mixed

offsetSet

public offsetSet(mixed $offset, mixed $value): void

Parameters

Parameter	Type	Description
$offset	mixed
$value	mixed

offsetUnset

public offsetUnset(mixed $offset): void

Parameters

Parameter	Type	Description
$offset	mixed

---

Generated by Hazaar API Doc Generator on Tue, 21 Apr 2026 04:00:24 +0000