mini\Http\Message\JsonResponse class

Documentation

JSON response with Content-Type: application/json

Use this for returning JSON data from routes:

return new JsonResponse(['users' => $users]); return new JsonResponse($data, [], 201); // Created return new JsonResponse(['error' => 'Not found'], [], 404);

Inheritance

Extends: mini\Http\Message\Response

Implements: Psr\Http\Message\MessageInterface Psr\Http\Message\ResponseInterface

Constants (1)

Name Value
PHRASES array ( 100 => 'Continue', 101 => 'Switching Protocols', 102 => 'Processing', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 207 => 'Multi-status', 208 => 'Already Reported', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 306 => 'Switch Proxy', 307 => 'Temporary Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Time-out', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Large', 415 => 'Unsupported Media Type', 416 => 'Requested range not satisfiable', 417 => 'Expectation Failed', 418 => 'I\'m a teapot', 422 => 'Unprocessable Entity', 423 => 'Locked', 424 => 'Failed Dependency', 425 => 'Unordered Collection', 426 => 'Upgrade Required', 428 => 'Precondition Required', 429 => 'Too Many Requests', 431 => 'Request Header Fields Too Large', 451 => 'Unavailable For Legal Reasons', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Time-out', 505 => 'HTTP Version not supported', 506 => 'Variant Also Negotiates', 507 => 'Insufficient Storage', 508 => 'Loop Detected', 511 => 'Network Authentication Required', )

Properties (6)

protected int $statusCode
protected string $reasonPhrase
protected string $protocolVersion
protected Psr\Http\Message\StreamInterface $body
protected array $headers
protected array $headerCases

Methods (19)

public __construct()

Documentation missing

protected ResponseTrait()
inherited from Http\Message\Response

Configure the response trait

public getStatusCode()
inherited from Http\Message\Response

Gets the response status code.

public withStatus()
inherited from Http\Message\Response

Return an instance with the specified status code and, optionally, reason phrase.

public getReasonPhrase()
inherited from Http\Message\Response

Gets the response reason phrase associated with the status code.

protected static getDefaultReasonPhrase()
inherited from Http\Message\Response

Documentation missing

public __clone()
inherited from Http\Message\Response

Documentation missing

protected MessageTrait()
inherited from Http\Message\Response

Configure the message trait.

public getProtocolVersion()
inherited from Http\Message\Response

Retrieves the HTTP protocol version as a string.

public withProtocolVersion()
inherited from Http\Message\Response

Return an instance with the specified HTTP protocol version.

public getHeaders()
inherited from Http\Message\Response

Get message headers

public hasHeader()
inherited from Http\Message\Response

Checks if a header exists by the given case-insensitive name.

public getHeader()
inherited from Http\Message\Response

Retrieves a message header value by the given case-insensitive name.

public getHeaderLine()
inherited from Http\Message\Response

Retrieves a comma-separated string of the values for a single header.

public withHeader()
inherited from Http\Message\Response

Return an instance with the provided value replacing the specified header.

public withAddedHeader()
inherited from Http\Message\Response

Return an instance with the specified header appended with the given value.

public withoutHeader()
inherited from Http\Message\Response

Return an instance without the specified header.

public getBody()
inherited from Http\Message\Response

Gets the body of the message.

public withBody()
inherited from Http\Message\Response

Return an instance with the specified message body.

Source

src/Http/Message/JsonResponse.php:13-26