JsonSerializer - Code Metrics - Inspection of "Supporting PHP Closure serialization" - zumba/json-serializer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#15)

by Juan

created 2016-02-29 01:47 UTC

JsonSerializer B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	291
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	20
Bugs	3	Features	8

Metric	Value
wmc	42
c	20
b	3
f	8
lcom	1
cbo	1
dl	0
loc	291
rs	8.295

13 Methods

Rating	Name	Size	Complexity
A	__construct()	10	3
A	serialize()	5	1
A	calculateEncodeOptions()	7	2
A	processEncodedValue()	6	2
A	unserialize()	4	1
D	serializeData()	26	10
A	serializeObject()	13	2
A	getObjectProperties()	11	3
A	extractObjectData()	13	3
B	unserializeData()	18	6
C	unserializeObject()	36	7
A	restoreUsingUnserialize()	5	1
A	reset()	5	1

How to fix Complexity

<?php

namespace Zumba\Util;

use ReflectionClass;
use ReflectionException;
use SplObjectStorage;
use Zumba\Exception\JsonSerializerException;
use SuperClosure\SerializerInterface as ClosureSerializerInterface;

class JsonSerializer {

	const CLASS_IDENTIFIER_KEY = '@type';
	const CLOSURE_IDENTIFIER_KEY = '@closure';
	const FLOAT_ADAPTER = 'JsonSerializerFloatAdapter';

	/**
	 * Storage for object
	 *
	 * Used for recursion
	 *
	 * @var SplObjectStorage
	 */
	protected $objectStorage;

	/**
	 * Object mapping for recursion
	 *
	 * @var array
	 */
	protected $objectMapping = array();

	/**
	 * Object mapping index
	 *
	 * @var integer
	 */
	protected $objectMappingIndex = 0;

	/**
	 * Support PRESERVE_ZERO_FRACTION json option
	 *
	 * @var boolean
	 */
	protected $preserveZeroFractionSupport;

	/**
	 * Closure serializer instance
	 *
	 * @var SuperClosure\SerializerInterface
	 */
	protected $closureSerializer;

	/**
	 * Constructor.
	 *
	 * @param SuperClosure\SerializerInterface $closureSerializer
	 */
	public function __construct(ClosureSerializerInterface $closureSerializer = null) {
		$this->preserveZeroFractionSupport = defined('JSON_PRESERVE_ZERO_FRACTION');

		if ($closureSerializer !== null) {
			if (!$closureSerializer instanceof ClosureSerializerInterface) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
				throw new JsonSerializerException('Invalid closure serializer given.');
			}
			$this->closureSerializer = $closureSerializer;

		}
	}

	/**
	 * Serialize the value in JSON
	 *
	 * @param mixed $value
	 * @return string JSON encoded
	 * @throws Zumba\Exception\JsonSerializerException
	 */
	public function serialize($value) {
		$this->reset();
		$encoded = json_encode($this->serializeData($value), $this->calculateEncodeOptions());
		return $this->processEncodedValue($encoded);
	}

	/**
	 * Calculate encoding options
	 *
	 * @return integer
	 */
	protected function calculateEncodeOptions() {
		$options = JSON_UNESCAPED_UNICODE;
		if ($this->preserveZeroFractionSupport) {
			$options |= JSON_PRESERVE_ZERO_FRACTION;
		}
		return $options;
	}

	/**
	 * Execute post-encoding actions
	 *
	 * @param string $encoded
	 * @return string
	 */
	protected function processEncodedValue($encoded) {
		if (!$this->preserveZeroFractionSupport) {
			$encoded = preg_replace('/"' . static::FLOAT_ADAPTER . '\((.*?)\)"/', '\1', $encoded);
		}
		return $encoded;
	}

	/**
	 * Unserialize the value from JSON
	 *
	 * @param string $value
	 * @return mixed
	 */
	public function unserialize($value) {
		$this->reset();
		return $this->unserializeData(json_decode($value, true));
	}

	/**
	 * Parse the data to be json encoded
	 *
	 * @param mixed $value
	 * @return mixed
	 * @throws Zumba\Exception\JsonSerializerException
	 */
	protected function serializeData($value) {
		if (is_scalar($value) || $value === null) {
			if (!$this->preserveZeroFractionSupport && is_float($value) && strpos((string)$value, '.') === false) {
				// Because the PHP bug #50224, the float numbers with no
				// precision numbers are converted to integers when encoded
				$value = static::FLOAT_ADAPTER . '(' . $value . '.0)';
			}
			return $value;
		}
		if (is_resource($value)) {
			throw new JsonSerializerException('Resource is not supported in JsonSerializer');
		}
		if (is_array($value)) {
			return array_map(array($this, __FUNCTION__), $value);
		}
		if ($value instanceof \Closure) {
			if ($this->closureSerializer === null) {
				throw new JsonSerializerException('Closure serializer not given. Unable to serialize closure.');
			}
			return array(
				static::CLOSURE_IDENTIFIER_KEY => true,
				'value' => $this->closureSerializer->serialize($value)
			);
		}
		return $this->serializeObject($value);
	}

	/**
	 * Extract the data from an object
	 *
	 * @param object $value
	 * @return array
	 */
	protected function serializeObject($value) {
		$ref = new ReflectionClass($value);

		if ($this->objectStorage->contains($value)) {
			return array(static::CLASS_IDENTIFIER_KEY => '@' . $this->objectStorage[$value]);
		}
		$this->objectStorage->attach($value, $this->objectMappingIndex++);

		$paramsToSerialize = $this->getObjectProperties($ref, $value);
		$data = array(static::CLASS_IDENTIFIER_KEY => $ref->getName());
		$data += array_map(array($this, 'serializeData'), $this->extractObjectData($value, $ref, $paramsToSerialize));
		return $data;
	}

	/**
	 * Return the list of properties to be serialized
	 *
	 * @param ReflectionClass $ref
	 * @param object $value
	 * @return array
	 */
	protected function getObjectProperties($ref, $value) {
		if (method_exists($value, '__sleep')) {
			return $value->__sleep();
		}

		$props = array();
		foreach ($ref->getProperties() as $prop) {
			$props[] = $prop->getName();
		}
		return array_unique(array_merge($props, array_keys(get_object_vars($value))));
	}

	/**
	 * Extract the object data
	 *
	 * @param object $value
	 * @param ReflectionClass $ref
	 * @param array $properties
	 * @return array
	 */
	protected function extractObjectData($value, $ref, $properties) {
		$data = array();
		foreach ($properties as $property) {
			try {
				$propRef = $ref->getProperty($property);
				$propRef->setAccessible(true);
				$data[$property] = $propRef->getValue($value);
			} catch (ReflectionException $e) {
				$data[$property] = $value->$property;
			}
		}
		return $data;
	}

	/**
	 * Parse the json decode to convert to objects again
	 *
	 * @param mixed $value
	 * @return mixed
	 */
	protected function unserializeData($value) {
		if (is_scalar($value) || $value === null) {
			return $value;
		}

		if (isset($value[static::CLASS_IDENTIFIER_KEY])) {
			return $this->unserializeObject($value);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		}

		if (!empty($value[static::CLOSURE_IDENTIFIER_KEY])) {
			if (!$this->closureSerializer) {
				throw new JsonSerializerException('Closure serializer not provided to unserialize closure');
			}
			return $this->closureSerializer->unserialize($value['value']);
		}

		return array_map(array($this, __FUNCTION__), $value);
	}

	/**
	 * Convert the serialized array into an object
	 *
	 * @param aray $value
	 * @return object
	 * @throws Zumba\Exception\JsonSerializerException
	 */
	protected function unserializeObject($value) {
		$className = $value[static::CLASS_IDENTIFIER_KEY];
		unset($value[static::CLASS_IDENTIFIER_KEY]);

		if ($className[0] === '@') {
			$index = substr($className, 1);
			return $this->objectMapping[$index];
		}

		if (!class_exists($className)) {
			throw new JsonSerializerException('Unable to find class ' . $className);
		}

		if ($className === 'DateTime') {
			$obj = $this->restoreUsingUnserialize($className, $value);
			$this->objectMapping[$this->objectMappingIndex++] = $obj;
			return $obj;
		}

		$ref = new ReflectionClass($className);
		$obj = $ref->newInstanceWithoutConstructor();
		$this->objectMapping[$this->objectMappingIndex++] = $obj;
		foreach ($value as $property => $propertyValue) {
			try {
				$propRef = $ref->getProperty($property);
				$propRef->setAccessible(true);
				$propRef->setValue($obj, $this->unserializeData($propertyValue));
			} catch (ReflectionException $e) {
				$obj->$property = $this->unserializeData($propertyValue);
			}
		}
		if (method_exists($obj, '__wakeup')) {
			$obj->__wakeup();
		}
		return $obj;
	}

	protected function restoreUsingUnserialize($className, $attributes) {
		$obj = (object)$attributes;
		$serialized = preg_replace('|^O:\d+:"\w+":|', 'O:' . strlen($className) . ':"' . $className . '":', serialize($obj));
		return unserialize($serialized);
	}

	/**
	 * Reset variables
	 *
	 * @return void
	 */
	protected function reset() {
		$this->objectStorage = new SplObjectStorage();
		$this->objectMapping = array();
		$this->objectMappingIndex = 0;
	}

}


GitHub Access Token became invalid

Pull Request — master (#15)

JsonSerializer B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

13 Methods

How to fix Complexity

Complex Class

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			namespace Zumba\Util;
4
5			use ReflectionClass;
6			use ReflectionException;
7			use SplObjectStorage;
8			use Zumba\Exception\JsonSerializerException;
9			use SuperClosure\SerializerInterface as ClosureSerializerInterface;
10
11			class JsonSerializer {
12
13			const CLASS_IDENTIFIER_KEY = '@type';
14			const CLOSURE_IDENTIFIER_KEY = '@closure';
15			const FLOAT_ADAPTER = 'JsonSerializerFloatAdapter';
16
17			/**
18			* Storage for object
19			*
20			* Used for recursion
21			*
22			* @var SplObjectStorage
23			*/
24			protected $objectStorage;
25
26			/**
27			* Object mapping for recursion
28			*
29			* @var array
30			*/
31			protected $objectMapping = array();
32
33			/**
34			* Object mapping index
35			*
36			* @var integer
37			*/
38			protected $objectMappingIndex = 0;
39
40			/**
41			* Support PRESERVE_ZERO_FRACTION json option
42			*
43			* @var boolean
44			*/
45			protected $preserveZeroFractionSupport;
46
47			/**
48			* Closure serializer instance
49			*
50			* @var SuperClosure\SerializerInterface
51			*/
52			protected $closureSerializer;
53
54			/**
55			* Constructor.
56			*
57			* @param SuperClosure\SerializerInterface $closureSerializer
58			*/
59			public function __construct(ClosureSerializerInterface $closureSerializer = null) {
60			$this->preserveZeroFractionSupport = defined('JSON_PRESERVE_ZERO_FRACTION');
61
62			if ($closureSerializer !== null) {
63			if (!$closureSerializer instanceof ClosureSerializerInterface) {
			0 ignored issues – show Bug introduced 2016-02-29 01:48 UTC by Report Bug Copy Issue Report The class `SuperClosure\SerializerInterface` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
64			throw new JsonSerializerException('Invalid closure serializer given.');
65			}
66			$this->closureSerializer = $closureSerializer;
			0 ignored issues – show Documentation Bug introduced 2016-02-29 01:48 UTC by Report Bug Copy Issue Report It seems like `$closureSerializer` of type `object<SuperClosure\SerializerInterface>` is incompatible with the declared type `object<Zumba\Util\SuperC...re\SerializerInterface>` of property `$closureSerializer`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
67			}
68			}
69
70			/**
71			* Serialize the value in JSON
72			*
73			* @param mixed $value
74			* @return string JSON encoded
75			* @throws Zumba\Exception\JsonSerializerException
76			*/
77			public function serialize($value) {
78			$this->reset();
79			$encoded = json_encode($this->serializeData($value), $this->calculateEncodeOptions());
80			return $this->processEncodedValue($encoded);
81			}
82
83			/**
84			* Calculate encoding options
85			*
86			* @return integer
87			*/
88			protected function calculateEncodeOptions() {
89			$options = JSON_UNESCAPED_UNICODE;
90			if ($this->preserveZeroFractionSupport) {
91			$options \|= JSON_PRESERVE_ZERO_FRACTION;
92			}
93			return $options;
94			}
95
96			/**
97			* Execute post-encoding actions
98			*
99			* @param string $encoded
100			* @return string
101			*/
102			protected function processEncodedValue($encoded) {
103			if (!$this->preserveZeroFractionSupport) {
104			$encoded = preg_replace('/"' . static::FLOAT_ADAPTER . '\((.*?)\)"/', '\1', $encoded);
105			}
106			return $encoded;
107			}
108
109			/**
110			* Unserialize the value from JSON
111			*
112			* @param string $value
113			* @return mixed
114			*/
115			public function unserialize($value) {
116			$this->reset();
117			return $this->unserializeData(json_decode($value, true));
118			}
119
120			/**
121			* Parse the data to be json encoded
122			*
123			* @param mixed $value
124			* @return mixed
125			* @throws Zumba\Exception\JsonSerializerException
126			*/
127			protected function serializeData($value) {
128			if (is_scalar($value) \|\| $value === null) {
129			if (!$this->preserveZeroFractionSupport && is_float($value) && strpos((string)$value, '.') === false) {
130			// Because the PHP bug #50224, the float numbers with no
131			// precision numbers are converted to integers when encoded
132			$value = static::FLOAT_ADAPTER . '(' . $value . '.0)';
133			}
134			return $value;
135			}
136			if (is_resource($value)) {
137			throw new JsonSerializerException('Resource is not supported in JsonSerializer');
138			}
139			if (is_array($value)) {
140			return array_map(array($this, __FUNCTION__), $value);
141			}
142			if ($value instanceof \Closure) {
143			if ($this->closureSerializer === null) {
144			throw new JsonSerializerException('Closure serializer not given. Unable to serialize closure.');
145			}
146			return array(
147			static::CLOSURE_IDENTIFIER_KEY => true,
148			'value' => $this->closureSerializer->serialize($value)
149			);
150			}
151			return $this->serializeObject($value);
152			}
153
154			/**
155			* Extract the data from an object
156			*
157			* @param object $value
158			* @return array
159			*/
160			protected function serializeObject($value) {
161			$ref = new ReflectionClass($value);
162
163			if ($this->objectStorage->contains($value)) {
164			return array(static::CLASS_IDENTIFIER_KEY => '@' . $this->objectStorage[$value]);
165			}
166			$this->objectStorage->attach($value, $this->objectMappingIndex++);
167
168			$paramsToSerialize = $this->getObjectProperties($ref, $value);
169			$data = array(static::CLASS_IDENTIFIER_KEY => $ref->getName());
170			$data += array_map(array($this, 'serializeData'), $this->extractObjectData($value, $ref, $paramsToSerialize));
171			return $data;
172			}
173
174			/**
175			* Return the list of properties to be serialized
176			*
177			* @param ReflectionClass $ref
178			* @param object $value
179			* @return array
180			*/
181			protected function getObjectProperties($ref, $value) {
182			if (method_exists($value, '__sleep')) {
183			return $value->__sleep();
184			}
185
186			$props = array();
187			foreach ($ref->getProperties() as $prop) {
188			$props[] = $prop->getName();
189			}
190			return array_unique(array_merge($props, array_keys(get_object_vars($value))));
191			}
192
193			/**
194			* Extract the object data
195			*
196			* @param object $value
197			* @param ReflectionClass $ref
198			* @param array $properties
199			* @return array
200			*/
201			protected function extractObjectData($value, $ref, $properties) {
202			$data = array();
203			foreach ($properties as $property) {
204			try {
205			$propRef = $ref->getProperty($property);
206			$propRef->setAccessible(true);
207			$data[$property] = $propRef->getValue($value);
208			} catch (ReflectionException $e) {
209			$data[$property] = $value->$property;
210			}
211			}
212			return $data;
213			}
214
215			/**
216			* Parse the json decode to convert to objects again
217			*
218			* @param mixed $value
219			* @return mixed
220			*/
221			protected function unserializeData($value) {
222			if (is_scalar($value) \|\| $value === null) {
223			return $value;
224			}
225
226			if (isset($value[static::CLASS_IDENTIFIER_KEY])) {
227			return $this->unserializeObject($value);
			0 ignored issues – show Documentation introduced 2016-02-29 01:48 UTC by Report Bug Copy Issue Report `$value` is of type `object\|array`, but the function expects a `object<Zumba\Util\aray>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
228			}
229
230			if (!empty($value[static::CLOSURE_IDENTIFIER_KEY])) {
231			if (!$this->closureSerializer) {
232			throw new JsonSerializerException('Closure serializer not provided to unserialize closure');
233			}
234			return $this->closureSerializer->unserialize($value['value']);
235			}
236
237			return array_map(array($this, __FUNCTION__), $value);
238			}
239
240			/**
241			* Convert the serialized array into an object
242			*
243			* @param aray $value
244			* @return object
245			* @throws Zumba\Exception\JsonSerializerException
246			*/
247			protected function unserializeObject($value) {
248			$className = $value[static::CLASS_IDENTIFIER_KEY];
249			unset($value[static::CLASS_IDENTIFIER_KEY]);
250
251			if ($className[0] === '@') {
252			$index = substr($className, 1);
253			return $this->objectMapping[$index];
254			}
255
256			if (!class_exists($className)) {
257			throw new JsonSerializerException('Unable to find class ' . $className);
258			}
259
260			if ($className === 'DateTime') {
261			$obj = $this->restoreUsingUnserialize($className, $value);
262			$this->objectMapping[$this->objectMappingIndex++] = $obj;
263			return $obj;
264			}
265
266			$ref = new ReflectionClass($className);
267			$obj = $ref->newInstanceWithoutConstructor();
268			$this->objectMapping[$this->objectMappingIndex++] = $obj;
269			foreach ($value as $property => $propertyValue) {
270			try {
271			$propRef = $ref->getProperty($property);
272			$propRef->setAccessible(true);
273			$propRef->setValue($obj, $this->unserializeData($propertyValue));
274			} catch (ReflectionException $e) {
275			$obj->$property = $this->unserializeData($propertyValue);
276			}
277			}
278			if (method_exists($obj, '__wakeup')) {
279			$obj->__wakeup();
280			}
281			return $obj;
282			}
283
284			protected function restoreUsingUnserialize($className, $attributes) {
285			$obj = (object)$attributes;
286			$serialized = preg_replace('\|^O:\d+:"\w+":\|', 'O:' . strlen($className) . ':"' . $className . '":', serialize($obj));
287			return unserialize($serialized);
288			}
289
290			/**
291			* Reset variables
292			*
293			* @return void
294			*/
295			protected function reset() {
296			$this->objectStorage = new SplObjectStorage();
297			$this->objectMapping = array();
298			$this->objectMappingIndex = 0;
299			}
300
301			}
302

zumba / json-serializer

GitHub Access Token became invalid

Pull Request — master (#15)

JsonSerializer B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

13 Methods

How to fix Complexity

Complex Class

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like