aleph1.co.uk Git - yaffs-website/blob - serializer/Encoder/JsonDecode.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\Serializer\Encoder;
  13
  14 use Symfony\Component\Serializer\Exception\NotEncodableValueException;
  15
  16 /**
  17  * Decodes JSON data.
  18  *
  19  * @author Sander Coolen <sander@jibber.nl>
  20  */
  21 class JsonDecode implements DecoderInterface
  22 {
  23     protected $serializer;
  24
  25     private $associative;
  26     private $recursionDepth;
  27
  28     /**
  29      * Constructs a new JsonDecode instance.
  30      *
  31      * @param bool $associative True to return the result associative array, false for a nested stdClass hierarchy
  32      * @param int  $depth       Specifies the recursion depth
  33      */
  34     public function __construct($associative = false, $depth = 512)
  35     {
  36         $this->associative = $associative;
  37         $this->recursionDepth = (int) $depth;
  38     }
  39
  40     /**
  41      * Decodes data.
  42      *
  43      * @param string $data    The encoded JSON string to decode
  44      * @param string $format  Must be set to JsonEncoder::FORMAT
  45      * @param array  $context An optional set of options for the JSON decoder; see below
  46      *
  47      * The $context array is a simple key=>value array, with the following supported keys:
  48      *
  49      * json_decode_associative: boolean
  50      *      If true, returns the object as associative array.
  51      *      If false, returns the object as nested stdClass
  52      *      If not specified, this method will use the default set in JsonDecode::__construct
  53      *
  54      * json_decode_recursion_depth: integer
  55      *      Specifies the maximum recursion depth
  56      *      If not specified, this method will use the default set in JsonDecode::__construct
  57      *
  58      * json_decode_options: integer
  59      *      Specifies additional options as per documentation for json_decode. Only supported with PHP 5.4.0 and higher
  60      *
  61      * @return mixed
  62      *
  63      * @throws NotEncodableValueException
  64      *
  65      * @see http://php.net/json_decode json_decode
  66      */
  67     public function decode($data, $format, array $context = array())
  68     {
  69         $context = $this->resolveContext($context);
  70
  71         $associative = $context['json_decode_associative'];
  72         $recursionDepth = $context['json_decode_recursion_depth'];
  73         $options = $context['json_decode_options'];
  74
  75         $decodedData = json_decode($data, $associative, $recursionDepth, $options);
  76
  77         if (JSON_ERROR_NONE !== json_last_error()) {
  78             throw new NotEncodableValueException(json_last_error_msg());
  79         }
  80
  81         return $decodedData;
  82     }
  83
  84     /**
  85      * {@inheritdoc}
  86      */
  87     public function supportsDecoding($format)
  88     {
  89         return JsonEncoder::FORMAT === $format;
  90     }
  91
  92     /**
  93      * Merges the default options of the Json Decoder with the passed context.
  94      *
  95      * @return array
  96      */
  97     private function resolveContext(array $context)
  98     {
  99         $defaultOptions = array(
 100             'json_decode_associative' => $this->associative,
 101             'json_decode_recursion_depth' => $this->recursionDepth,
 102             'json_decode_options' => 0,
 103         );
 104
 105         return array_merge($defaultOptions, $context);
 106     }
 107 }