Référence de la classe JsonResponse

Graphe d'héritage de JsonResponse:

Fonctions membres publiques
	__construct ( $data, int $status=200, array $headers=[], int $encodingOptions=self::DEFAULT_JSON_FLAGS)
	getPayload ()
	withPayload ($data)
	getEncodingOptions ()
	withEncodingOptions (int $encodingOptions)
Fonctions membres publiques hérités de Response
	__construct ($body='php://memory', int $status=200, array $headers=[])
	getStatusCode ()
	getReasonPhrase ()
	withStatus ($code, $reasonPhrase='')
Fonctions membres publiques hérités de MessageInterface
	getProtocolVersion ()
	withProtocolVersion ($version)
	getHeaders ()
	hasHeader ($name)
	getHeader ($name)
	getHeaderLine ($name)
	withHeader ($name, $value)
	withAddedHeader ($name, $value)
	withoutHeader ($name)
	getBody ()
	withBody (StreamInterface $body)

Champs de données
const	DEFAULT_JSON_FLAGS = 79
Champs de données hérités de Response
const	MIN_STATUS_CODE_VALUE = 100
const	MAX_STATUS_CODE_VALUE = 599

Fonctions membres privées
	createBodyFromJson (string $json)
	jsonEncode ($data, int $encodingOptions)
	setPayload ($data)
	updateBodyFor (JsonResponse $toUpdate)

Attributs privés
	$payload
	$encodingOptions

Description détaillée

JSON response.

Allows creating a response by passing data to the constructor; by default, serializes the data to JSON, sets a status code of 200 and sets the Content-Type header to application/json.

Documentation des constructeurs et destructeur

__construct()

__construct	(		$data,
		int	$status = 200,
		array	$headers = [],
		int	$encodingOptions = self::DEFAULT_JSON_FLAGS
	)

Create a JSON response with the given data.

Default JSON encoding is performed with the following options, which produces RFC4627-compliant JSON, capable of embedding into HTML.

• JSON_HEX_TAG
• JSON_HEX_APOS
• JSON_HEX_AMP
• JSON_HEX_QUOT
• JSON_UNESCAPED_SLASHES

Paramètres

mixed	$data	Data to convert to JSON.
int	$status	Integer status code for the response; 200 by default.
array	$headers	Array of headers to use at initialization.
int	$encodingOptions	JSON encoding options to use.

Exceptions

Exception

Références $data, JsonResponse\$encodingOptions, Symfony\Contracts\Service\__construct(), JsonResponse\createBodyFromJson(), JsonResponse\jsonEncode(), et JsonResponse\setPayload().

Documentation des fonctions membres

createBodyFromJson()

createBodyFromJson ( string  $json )

private

Référencé par JsonResponse\__construct(), et JsonResponse\updateBodyFor().

getEncodingOptions()

getEncodingOptions

(

)

Références JsonResponse\$encodingOptions.

getPayload()

getPayload

(

)

Renvoie

mixed

Références JsonResponse\$payload.

jsonEncode()

jsonEncode (   $data, int  $encodingOptions  )

private

Encode the provided data to JSON.

Paramètres

mixed

$data

Exceptions

Exception

Références $data, JsonResponse\$encodingOptions, et null.

Référencé par JsonResponse\__construct(), et JsonResponse\updateBodyFor().

setPayload()

setPayload (   $data )

private

Paramètres

mixed

$data

Références $data.

Référencé par JsonResponse\__construct().

updateBodyFor()

updateBodyFor ( JsonResponse  $toUpdate )

private

Update the response body for the given instance.

Paramètres

self

$toUpdate

Instance to update.

Renvoie

JsonResponse Returns a new instance with an updated body.

Références JsonResponse\createBodyFromJson(), JsonResponse\jsonEncode(), et MessageInterface\withBody().

Référencé par JsonResponse\withEncodingOptions(), et JsonResponse\withPayload().

withEncodingOptions()

withEncodingOptions

(

int

$encodingOptions

)

Références JsonResponse\$encodingOptions, $this, et JsonResponse\updateBodyFor().

withPayload()

withPayload

(

$data

)

Paramètres

mixed

$data

Références $data, $this, et JsonResponse\updateBodyFor().

Documentation des champs

$encodingOptions

$encodingOptions

private

Référencé par JsonResponse\__construct(), JsonResponse\getEncodingOptions(), JsonResponse\jsonEncode(), et JsonResponse\withEncodingOptions().

$payload

$payload

private

Référencé par JsonResponse\getPayload().

DEFAULT_JSON_FLAGS

const DEFAULT_JSON_FLAGS = 79

Default flags for json_encode; value of:

JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_SLASHES

int

---

La documentation de cette classe a été générée à partir du fichier suivant :

• libraries/vendor/laminas/laminas-diactoros/src/Response/JsonResponse.php