Json Class Reference

Inheritance diagram for Json:

Public Member Functions
	__construct (InlineInterface $translateInline, \Magento\Framework\Serialize\Serializer\Json $serializer=null)
	setData ($data, $cycleCheck=false, $options=[])
	setJsonData ($jsonData)
Public Member Functions inherited from AbstractResult
	setHttpResponseCode ($httpCode)
	setHeader ($name, $value, $replace=false)
	setStatusHeader ($httpCode, $version=null, $phrase=null)
	renderResult (ResponseInterface $response)

Protected Member Functions
	render (HttpResponseInterface $response)
Protected Member Functions inherited from AbstractResult
	applyHttpHeaders (HttpResponseInterface $response)
	render (HttpResponseInterface $response)

Protected Attributes
	$translateInline
	$json
Protected Attributes inherited from AbstractResult
	$httpResponseCode
	$headers = []
	$statusHeaderCode
	$statusHeaderVersion
	$statusHeaderPhrase

Detailed Description

A possible implementation of JSON response type (instead of hardcoding json_encode() all over the place) Actual for controller actions that serve ajax requests

@api

Since

100.0.2

Definition at line 20 of file Json.php.

Constructor & Destructor Documentation

__construct()

__construct	(	InlineInterface	$translateInline,
		\Magento\Framework\Serialize\Serializer\Json	$serializer = null
	)

Parameters

\Magento\Framework\Translate\InlineInterface	$translateInline
\Magento\Framework\Serialize\Serializer\Json	$serializer

Definition at line 41 of file Json.php.

      {
        $this->translateInline = $translateInline;
        $this->serializer = $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()
            ->get(\Magento\Framework\Serialize\Serializer\Json::class);
    }

Member Function Documentation

render()

render ( HttpResponseInterface  $response )

protected

{}

Definition at line 81 of file Json.php.

    {
        $this->translateInline->processResponseBody($this->json, true);
        $response->setHeader('Content-Type', 'application/json', true);
        $response->setBody($this->json);
        return $this;
    }

setData()

setData	(		$data,
			$cycleCheck = false,
			$options = []
	)

Set json data

Parameters

mixed	$data
boolean	$cycleCheck	Optional; whether or not to check for object recursion; off by default
array	$options	Additional options used during encoding

Returns

$this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 59 of file Json.php.

    {
        if ($data instanceof \Magento\Framework\DataObject) {
            $data = $data->toArray();
        }
        $this->json = $this->serializer->serialize($data);
        return $this;
    }

setJsonData()

setJsonData

(

$jsonData

)

Parameters

string

$jsonData

Returns

$this

Definition at line 72 of file Json.php.

    {
        $this->json = (string)$jsonData;
        return $this;
    }

Field Documentation

$json

$json

protected

Definition at line 30 of file Json.php.

$translateInline

$translateInline

protected

Definition at line 25 of file Json.php.

---

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

• vendor/magento/framework/Controller/Result/Json.php