2015-08-17 17:00:26 -07:00
< ? php
/*
* This file is part of the Symfony package .
*
* ( c ) Fabien Potencier < fabien @ symfony . com >
*
* For the full copyright and license information , please view the LICENSE
* file that was distributed with this source code .
*/
namespace Symfony\Component\Serializer\Encoder ;
2018-11-23 12:29:20 +00:00
use Symfony\Component\Serializer\Exception\NotEncodableValueException ;
2015-08-17 17:00:26 -07:00
/**
* Decodes JSON data .
*
* @ author Sander Coolen < sander @ jibber . nl >
*/
class JsonDecode implements DecoderInterface
{
2018-11-23 12:29:20 +00:00
protected $serializer ;
2015-08-17 17:00:26 -07:00
2018-11-23 12:29:20 +00:00
private $associative ;
2015-08-17 17:00:26 -07:00
private $recursionDepth ;
/**
* Constructs a new JsonDecode instance .
*
* @ param bool $associative True to return the result associative array , false for a nested stdClass hierarchy
* @ param int $depth Specifies the recursion depth
*/
public function __construct ( $associative = false , $depth = 512 )
{
$this -> associative = $associative ;
$this -> recursionDepth = ( int ) $depth ;
}
/**
* Decodes data .
*
* @ param string $data The encoded JSON string to decode
* @ param string $format Must be set to JsonEncoder :: FORMAT
* @ param array $context An optional set of options for the JSON decoder ; see below
*
* The $context array is a simple key => value array , with the following supported keys :
*
* json_decode_associative : boolean
* If true , returns the object as associative array .
* If false , returns the object as nested stdClass
* If not specified , this method will use the default set in JsonDecode :: __construct
*
* json_decode_recursion_depth : integer
* Specifies the maximum recursion depth
* If not specified , this method will use the default set in JsonDecode :: __construct
*
* json_decode_options : integer
* Specifies additional options as per documentation for json_decode . Only supported with PHP 5.4 . 0 and higher
*
* @ return mixed
*
2018-11-23 12:29:20 +00:00
* @ throws NotEncodableValueException
2015-08-17 17:00:26 -07:00
*
* @ see http :// php . net / json_decode json_decode
*/
public function decode ( $data , $format , array $context = array ())
{
$context = $this -> resolveContext ( $context );
$associative = $context [ 'json_decode_associative' ];
$recursionDepth = $context [ 'json_decode_recursion_depth' ];
$options = $context [ 'json_decode_options' ];
2018-11-23 12:29:20 +00:00
$decodedData = json_decode ( $data , $associative , $recursionDepth , $options );
2015-08-17 17:00:26 -07:00
2018-11-23 12:29:20 +00:00
if ( JSON_ERROR_NONE !== json_last_error ()) {
throw new NotEncodableValueException ( json_last_error_msg ());
2015-08-17 17:00:26 -07:00
}
return $decodedData ;
}
/**
* { @ inheritdoc }
*/
public function supportsDecoding ( $format )
{
return JsonEncoder :: FORMAT === $format ;
}
/**
* Merges the default options of the Json Decoder with the passed context .
*
* @ return array
*/
private function resolveContext ( array $context )
{
$defaultOptions = array (
'json_decode_associative' => $this -> associative ,
'json_decode_recursion_depth' => $this -> recursionDepth ,
'json_decode_options' => 0 ,
);
return array_merge ( $defaultOptions , $context );
}
}