PHPXRef 0.7.1 : phpBB-3.3.14-deutsch : Detail view of JsonResponse.php

(no description)

File Size:	235 lines (8 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

JsonResponse:: (9 methods):
  __construct()
  create()
  fromJsonString()
  setCallback()
  setJson()
  setData()
  getEncodingOptions()
  setEncodingOptions()
  update()

Class: JsonResponse - X-Ref

Response represents an HTTP response in JSON format.

Note that this class does not force the returned JSON content to be an
object. It is however recommended that you do return an object as it
protects yourself against XSSI and JSON-JavaScript Hijacking.

__construct($data = null, $status = 200, $headers = [], $json = false) X-Ref

param: mixed $data    The response data
param: int   $status  The response status code
param: array $headers An array of response headers
param: bool  $json    If the data is already a JSON string

create($data = null, $status = 200, $headers = []) X-Ref

Factory method for chainability.

Example:

return JsonResponse::create(['key' => 'value'])
->setSharedMaxAge(300);

param: mixed $data The JSON response data
param: int $status The response status code
param: array $headers An array of response headers
return: static

fromJsonString($data = null, $status = 200, $headers = []) X-Ref

Factory method for chainability.

Example:

return JsonResponse::fromJsonString('{"key": "value"}')
->setSharedMaxAge(300);

param: string|null $data    The JSON response string
param: int         $status  The response status code
param: array       $headers An array of response headers
return: static

setCallback($callback = null) X-Ref

Sets the JSONP callback.

param: string|null $callback The JSONP callback or null to use none
return: $this

setJson($json) X-Ref

Sets a raw string containing a JSON document to be sent.

param: string $json
return: $this

setData($data = []) X-Ref

Sets the data to be sent as JSON.

param: mixed $data
return: $this

getEncodingOptions() X-Ref

Returns options used while encoding data to JSON.

return: int

setEncodingOptions($encodingOptions) X-Ref

Sets options used while encoding data to JSON.

param: int $encodingOptions
return: $this

update() X-Ref

Updates the content and headers according to the JSON data and callback.

return: $this

PHP Cross Reference of phpBB-3.3.14-deutsch

/vendor/symfony/http-foundation/ -> JsonResponse.php (summary)

Defines 1 class