Inheritance diagram for Symfony\Component\HttpFoundation\JsonResponse:

Public Member Functions
	__construct ($data=null, $status=200, $headers=array(), $json=false)

	__construct ($data=null, int $status=200, array $headers=[], bool $json=false)

	getEncodingOptions ()

	getEncodingOptions ()

	setCallback ($callback=null)

	setCallback ($callback=null)

	setData ($data=[])

	setData ($data=array())

	setEncodingOptions ($encodingOptions)

	setEncodingOptions ($encodingOptions)

	setJson ($json)

	setJson ($json)

Public Member Functions inherited from Symfony\Component\HttpFoundation\Response
	__clone ()

	__clone ()

	__construct ($content='', $status=200, $headers=array())

	__construct ($content='', int $status=200, array $headers=[])

	__toString ()

	__toString ()

	expire ()

	expire ()

	getAge ()

	getAge ()

	getCharset ()

	getCharset ()

	getContent ()

	getContent ()

	getDate ()

	getDate ()

	getEtag ()

	getEtag ()

	getExpires ()

	getExpires ()

	getLastModified ()

	getLastModified ()

	getMaxAge ()

	getMaxAge ()

	getProtocolVersion ()

	getProtocolVersion ()

	getStatusCode ()

	getStatusCode ()

	getTtl ()

	getTtl ()

	getVary ()

	getVary ()

	hasVary ()

	hasVary ()

	isCacheable ()

	isCacheable ()

	isClientError ()

	isClientError ()

	isEmpty ()

	isEmpty ()

	isForbidden ()

	isForbidden ()

	isFresh ()

	isFresh ()

	isImmutable ()

	isInformational ()

	isInformational ()

	isInvalid ()

	isInvalid ()

	isNotFound ()

	isNotFound ()

	isNotModified (Request $request)

	isNotModified (Request $request)

	isOk ()

	isOk ()

	isRedirect ($location=null)

	isRedirect (string $location=null)

	isRedirection ()

	isRedirection ()

	isServerError ()

	isServerError ()

	isSuccessful ()

	isSuccessful ()

	isValidateable ()

	isValidateable ()

	mustRevalidate ()

	mustRevalidate ()

	prepare (Request $request)

	prepare (Request $request)

	send ()

	send ()

	sendContent ()

	sendContent ()

	sendHeaders ()

	sendHeaders ()

	setCache (array $options)

	setCache (array $options)

	setCharset ($charset)

	setCharset (string $charset)

	setClientTtl ($seconds)

	setClientTtl (int $seconds)

	setContent ($content)

	setContent ($content)

	setDate (\DateTime $date)

	setDate (\DateTimeInterface $date)

	setEtag ($etag=null, $weak=false)

	setEtag (string $etag=null, bool $weak=false)

	setExpires (\DateTime $date=null)

	setExpires (\DateTimeInterface $date=null)

	setImmutable (bool $immutable=true)

	setLastModified (\DateTime $date=null)

	setLastModified (\DateTimeInterface $date=null)

	setMaxAge ($value)

	setMaxAge (int $value)

	setNotModified ()

	setNotModified ()

	setPrivate ()

	setPrivate ()

	setProtocolVersion ($version)

	setProtocolVersion (string $version)

	setPublic ()

	setPublic ()

	setSharedMaxAge ($value)

	setSharedMaxAge (int $value)

	setStatusCode ($code, $text=null)

	setStatusCode (int $code, $text=null)

	setTtl ($seconds)

	setTtl (int $seconds)

	setVary ($headers, $replace=true)

	setVary ($headers, bool $replace=true)

Static Public Member Functions
static	create ($data=null, $status=200, $headers=[])

static	create ($data=null, $status=200, $headers=array())

static	fromJsonString ($data=null, $status=200, $headers=[])

static	fromJsonString ($data=null, $status=200, $headers=array())

Static Public Member Functions inherited from Symfony\Component\HttpFoundation\Response
static	closeOutputBuffers ($targetLevel, $flush)

static	closeOutputBuffers (int $targetLevel, bool $flush)

Data Fields
const	DEFAULT_ENCODING_OPTIONS = 15

Data Fields inherited from Symfony\Component\HttpFoundation\Response
	$headers

const	HTTP_ACCEPTED = 202

const	HTTP_ALREADY_REPORTED = 208

const	HTTP_BAD_GATEWAY = 502

const	HTTP_BAD_REQUEST = 400

const	HTTP_CONFLICT = 409

const	HTTP_CONTINUE = 100

const	HTTP_CREATED = 201

const	HTTP_EARLY_HINTS = 103

const	HTTP_EXPECTATION_FAILED = 417

const	HTTP_FAILED_DEPENDENCY = 424

const	HTTP_FORBIDDEN = 403

const	HTTP_FOUND = 302

const	HTTP_GATEWAY_TIMEOUT = 504

const	HTTP_GONE = 410

const	HTTP_I_AM_A_TEAPOT = 418

const	HTTP_IM_USED = 226

const	HTTP_INSUFFICIENT_STORAGE = 507

const	HTTP_INTERNAL_SERVER_ERROR = 500

const	HTTP_LENGTH_REQUIRED = 411

const	HTTP_LOCKED = 423

const	HTTP_LOOP_DETECTED = 508

const	HTTP_METHOD_NOT_ALLOWED = 405

const	HTTP_MISDIRECTED_REQUEST = 421

const	HTTP_MOVED_PERMANENTLY = 301

const	HTTP_MULTI_STATUS = 207

const	HTTP_MULTIPLE_CHOICES = 300

const	HTTP_NETWORK_AUTHENTICATION_REQUIRED = 511

const	HTTP_NO_CONTENT = 204

const	HTTP_NON_AUTHORITATIVE_INFORMATION = 203

const	HTTP_NOT_ACCEPTABLE = 406

const	HTTP_NOT_EXTENDED = 510

const	HTTP_NOT_FOUND = 404

const	HTTP_NOT_IMPLEMENTED = 501

const	HTTP_NOT_MODIFIED = 304

const	HTTP_OK = 200

const	HTTP_PARTIAL_CONTENT = 206

const	HTTP_PAYMENT_REQUIRED = 402

const	HTTP_PERMANENTLY_REDIRECT = 308

const	HTTP_PRECONDITION_FAILED = 412

const	HTTP_PRECONDITION_REQUIRED = 428

const	HTTP_PROCESSING = 102

const	HTTP_PROXY_AUTHENTICATION_REQUIRED = 407

const	HTTP_REQUEST_ENTITY_TOO_LARGE = 413

const	HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431

const	HTTP_REQUEST_TIMEOUT = 408

const	HTTP_REQUEST_URI_TOO_LONG = 414

const	HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416

const	HTTP_RESERVED = 306

const	HTTP_RESERVED_FOR_WEBDAV_ADVANCED_COLLECTIONS_EXPIRED_PROPOSAL = 425

const	HTTP_RESET_CONTENT = 205

const	HTTP_SEE_OTHER = 303

const	HTTP_SERVICE_UNAVAILABLE = 503

const	HTTP_SWITCHING_PROTOCOLS = 101

const	HTTP_TEMPORARY_REDIRECT = 307

const	HTTP_TOO_EARLY = 425

const	HTTP_TOO_MANY_REQUESTS = 429

const	HTTP_UNAUTHORIZED = 401

const	HTTP_UNAVAILABLE_FOR_LEGAL_REASONS = 451

const	HTTP_UNPROCESSABLE_ENTITY = 422

const	HTTP_UNSUPPORTED_MEDIA_TYPE = 415

const	HTTP_UPGRADE_REQUIRED = 426

const	HTTP_USE_PROXY = 305

const	HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL = 506

const	HTTP_VERSION_NOT_SUPPORTED = 505

Protected Member Functions
	update ()

	update ()

Protected Member Functions inherited from Symfony\Component\HttpFoundation\Response
	ensureIEOverSSLCompatibility (Request $request)

	ensureIEOverSSLCompatibility (Request $request)

Protected Attributes
	$callback

	$data

	$encodingOptions = self::DEFAULT_ENCODING_OPTIONS

Protected Attributes inherited from Symfony\Component\HttpFoundation\Response
	$charset

	$content

	$statusCode

	$statusText

	$version

Additional Inherited Members
Static Public Attributes inherited from Symfony\Component\HttpFoundation\Response
static	$statusTexts

Detailed Description

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.

See also: https://www.owasp.org/index.php/OWASP_AJAX_Security_Guidelines#Always_return_JSON_with_an_Object_on_the_outside

Author: Igor Wiedler igor@.nosp@m.wied.nosp@m.ler.c.nosp@m.h

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.

See also: https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/AJAX_Security_Cheat_Sheet.md#always-return-json-with-an-object-on-the-outside

Author: Igor Wiedler igor@.nosp@m.wied.nosp@m.ler.c.nosp@m.h

Definition at line 25 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

Constructor & Destructor Documentation

◆ __construct() [1/2]

Symfony\Component\HttpFoundation\JsonResponse::__construct	(	$data = `null`,
		$status = `200`,
		$headers = `array()`,
		$json = `false`
	)

Parameters

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

Definition at line 42 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$data, Symfony\Component\HttpFoundation\Response\$headers, Symfony\Component\HttpFoundation\JsonResponse\setData(), and Symfony\Component\HttpFoundation\JsonResponse\setJson().

◆ __construct() [2/2]

Symfony\Component\HttpFoundation\JsonResponse::__construct	(		$data = `null`,
		int	$status = `200`,
		array	$headers = `[]`,
		bool	$json = `false`
	)

Parameters

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

Definition at line 42 of file vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$data, Symfony\Component\HttpFoundation\Response\$headers, Symfony\Component\HttpFoundation\JsonResponse\setData(), and Symfony\Component\HttpFoundation\JsonResponse\setJson().

Member Function Documentation

◆ create() [1/2]

static Symfony\Component\HttpFoundation\JsonResponse::create	(	$data = `null`,
		$status = `200`,
		$headers = `[]`
	)

static

Factory method for chainability.

Example:

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

Parameters

mixed	$data	The JSON response data
int	$status	The response status code
array	$headers	An array of response headers

Returns: static

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 67 of file vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$data, and Symfony\Component\HttpFoundation\Response\$headers.

◆ create() [2/2]

static Symfony\Component\HttpFoundation\JsonResponse::create	(	$data = `null`,
		$status = `200`,
		$headers = `array()`
	)

static

Factory method for chainability.

Example:

return JsonResponse::create($data, 200)
    ->setSharedMaxAge(300);

Parameters

mixed	$data	The json response data
int	$status	The response status code
array	$headers	An array of response headers

Returns: static

Reimplemented from Symfony\Component\HttpFoundation\Response.

Definition at line 67 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$data, and Symfony\Component\HttpFoundation\Response\$headers.

◆ fromJsonString() [1/2]

static Symfony\Component\HttpFoundation\JsonResponse::fromJsonString	(	$data = `null`,
		$status = `200`,
		$headers = `[]`
	)

static

Factory method for chainability.

Example:

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

Parameters

string \| null	$data	The JSON response string
int	$status	The response status code
array	$headers	An array of response headers

Returns: static

Definition at line 86 of file vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$data, and Symfony\Component\HttpFoundation\Response\$headers.

◆ fromJsonString() [2/2]

static Symfony\Component\HttpFoundation\JsonResponse::fromJsonString	(	$data = `null`,
		$status = `200`,
		$headers = `array()`
	)

static

Make easier the creation of JsonResponse from raw json.

Definition at line 75 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$data, and Symfony\Component\HttpFoundation\Response\$headers.

Referenced by Symfony\Component\HttpFoundation\Tests\JsonResponseTest\testItAcceptsJsonAsString().

◆ getEncodingOptions() [1/2]

Symfony\Component\HttpFoundation\JsonResponse::getEncodingOptions ( )

Returns options used while encoding data to JSON.

Returns: int

Definition at line 173 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$encodingOptions.

◆ getEncodingOptions() [2/2]

Symfony\Component\HttpFoundation\JsonResponse::getEncodingOptions ( )

Returns options used while encoding data to JSON.

Returns: int

Definition at line 178 of file vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$encodingOptions.

◆ setCallback() [1/2]

Symfony\Component\HttpFoundation\JsonResponse::setCallback ( $callback = null )

Sets the JSONP callback.

Parameters

string | null $callback The JSONP callback or null to use none

Returns: $this

Exceptions

Definition at line 89 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$callback, and Symfony\Component\HttpFoundation\JsonResponse\update().

◆ setCallback() [2/2]

Symfony\Component\HttpFoundation\JsonResponse::setCallback ( $callback = null )

Sets the JSONP callback.

Parameters

string | null $callback The JSONP callback or null to use none

Returns: $this

Exceptions

Definition at line 100 of file vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$callback, and Symfony\Component\HttpFoundation\JsonResponse\update().

◆ setData() [1/2]

Symfony\Component\HttpFoundation\JsonResponse::setData ( $data = [] )

Sets the data to be sent as JSON.

Parameters

mixed $data

Returns: $this

Exceptions

Definition at line 151 of file vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$data, and Symfony\Component\HttpFoundation\JsonResponse\setJson().

◆ setData() [2/2]

Symfony\Component\HttpFoundation\JsonResponse::setData ( $data = array() )

Sets the data to be sent as JSON.

Parameters

mixed $data

Returns: $this

Exceptions

Definition at line 140 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$data, and Symfony\Component\HttpFoundation\JsonResponse\setJson().

Referenced by Symfony\Component\HttpFoundation\JsonResponse\__construct(), and Symfony\Component\HttpFoundation\JsonResponse\setEncodingOptions().

◆ setEncodingOptions() [1/2]

Symfony\Component\HttpFoundation\JsonResponse::setEncodingOptions ( $encodingOptions )

Sets options used while encoding data to JSON.

Parameters

int $encodingOptions

Returns: $this

Definition at line 185 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$encodingOptions, and Symfony\Component\HttpFoundation\JsonResponse\setData().

◆ setEncodingOptions() [2/2]

Symfony\Component\HttpFoundation\JsonResponse::setEncodingOptions ( $encodingOptions )

Sets options used while encoding data to JSON.

Parameters

int $encodingOptions

Returns: $this

Definition at line 190 of file vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\$encodingOptions, and Symfony\Component\HttpFoundation\JsonResponse\setData().

◆ setJson() [1/2]

Symfony\Component\HttpFoundation\JsonResponse::setJson ( $json )

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

Parameters

string $json

Returns: $this

Exceptions

Definition at line 124 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\update().

Referenced by Symfony\Component\HttpFoundation\JsonResponse\__construct(), and Symfony\Component\HttpFoundation\JsonResponse\setData().

◆ setJson() [2/2]

Symfony\Component\HttpFoundation\JsonResponse::setJson ( $json )

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

Parameters

string $json

Returns: $this

Exceptions

Definition at line 135 of file vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\JsonResponse\update().

◆ update() [1/2]

Symfony\Component\HttpFoundation\JsonResponse::update ( )

protected

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

Returns: $this

Definition at line 197 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\Response\setContent().

Referenced by Symfony\Component\HttpFoundation\JsonResponse\setCallback(), and Symfony\Component\HttpFoundation\JsonResponse\setJson().

◆ update() [2/2]

Symfony\Component\HttpFoundation\JsonResponse::update ( )

protected

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

Returns: $this

Definition at line 202 of file vendor/symfony/http-foundation/JsonResponse.php.

References Symfony\Component\HttpFoundation\Response\setContent().

Field Documentation

◆ $callback

Symfony\Component\HttpFoundation\JsonResponse::$callback

protected

Definition at line 28 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

Referenced by Symfony\Component\HttpFoundation\JsonResponse\setCallback().

◆ $data

Symfony\Component\HttpFoundation\JsonResponse::$data

protected

Definition at line 27 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

Referenced by Symfony\Component\HttpFoundation\JsonResponse\__construct(), Symfony\Component\HttpFoundation\JsonResponse\create(), Symfony\Component\HttpFoundation\JsonResponse\fromJsonString(), and Symfony\Component\HttpFoundation\JsonResponse\setData().

◆ $encodingOptions

Symfony\Component\HttpFoundation\JsonResponse::$encodingOptions = self::DEFAULT_ENCODING_OPTIONS

protected

Definition at line 34 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

Referenced by Symfony\Component\HttpFoundation\JsonResponse\getEncodingOptions(), and Symfony\Component\HttpFoundation\JsonResponse\setEncodingOptions().

◆ DEFAULT_ENCODING_OPTIONS

const Symfony\Component\HttpFoundation\JsonResponse::DEFAULT_ENCODING_OPTIONS = 15

Definition at line 32 of file lib/vendor/symfony/http-foundation/JsonResponse.php.

The documentation for this class was generated from the following file:

lib/vendor/symfony/http-foundation/JsonResponse.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct() [1/2]

◆ __construct() [2/2]

Member Function Documentation

◆ create() [1/2]

◆ create() [2/2]

◆ fromJsonString() [1/2]

◆ fromJsonString() [2/2]

◆ getEncodingOptions() [1/2]

◆ getEncodingOptions() [2/2]

◆ setCallback() [1/2]

◆ setCallback() [2/2]

◆ setData() [1/2]

◆ setData() [2/2]

◆ setEncodingOptions() [1/2]

◆ setEncodingOptions() [2/2]

◆ setJson() [1/2]

◆ setJson() [2/2]

◆ update() [1/2]

◆ update() [2/2]

Field Documentation

◆ $callback

◆ $data

◆ $encodingOptions

◆ DEFAULT_ENCODING_OPTIONS