JsonSerializationVisitor::visitString() - Code Metrics - Inspection of "implement @SkipWhenEmpty for strings" - schmittjoh/serializer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#883)

unknown

created 2018-03-07 11:09 UTC

JsonSerializationVisitor::visitString() A

↳ Parent: JsonSerializationVisitor

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	4
cts	4
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	3
crap	2

<?php

/*
 * Copyright 2016 Johannes M. Schmitt <[email protected]>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace JMS\Serializer;

use JMS\Serializer\Exception\InvalidArgumentException;
use JMS\Serializer\Metadata\ClassMetadata;
use JMS\Serializer\Metadata\PropertyMetadata;
use JMS\Serializer\Naming\AdvancedNamingStrategyInterface;

class JsonSerializationVisitor extends GenericSerializationVisitor

{
    private $options = 0;

    private $navigator;

    private $root;

    private $dataStack;

    private $data;


    public function setNavigator(GraphNavigator $navigator)
    {
        $this->navigator = $navigator;
        $this->root = null;
        $this->dataStack = new \SplStack;
    }

    /**
     * @return GraphNavigator
     */
    public function getNavigator()
    {
        return $this->navigator;
    }

    public function visitNull($data, array $type, Context $context)
    {
        return null;
    }

    public function visitString($data, array $type, Context $context)
    {
        if (null === $this->root) {
            $this->root = $data;
        }

        return (string)$data;
    }

    public function visitBoolean($data, array $type, Context $context)
    {
        if (null === $this->root) {
            $this->root = $data;
        }

        return (boolean)$data;
    }

    public function visitInteger($data, array $type, Context $context)
    {
        if (null === $this->root) {
            $this->root = $data;
        }

        return (int)$data;
    }

    public function visitDouble($data, array $type, Context $context)
    {
        if (null === $this->root) {
            $this->root = $data;
        }

        return (float)$data;
    }

    /**
     * @param array $data
     * @param array $type
     * @param Context $context
     * @return mixed
     */
    public function visitArray($data, array $type, Context $context)
    {
        $this->dataStack->push($data);

        $isHash = isset($type['params'][1]);

        if (null === $this->root) {
            $this->root = $isHash ? new \ArrayObject() : array();
            $rs = &$this->root;
        } else {
            $rs = $isHash ? new \ArrayObject() : array();
        }

        $isList = isset($type['params'][0]) && !isset($type['params'][1]);

        foreach ($data as $k => $v) {
            $v = $this->navigator->accept($v, $this->getElementType($type), $context);

            if (null === $v && $context->shouldSerializeNull() !== true) {
                continue;
            }

            if ($isList) {
                $rs[] = $v;
            } else {
                $rs[$k] = $v;
            }
        }

        $this->dataStack->pop();
        return $rs;
    }

    public function startVisitingObject(ClassMetadata $metadata, $data, array $type, Context $context)
    {
        if (null === $this->root) {
            $this->root = new \stdClass;
        }

        $this->dataStack->push($this->data);
        $this->data = array();
    }

    public function endVisitingObject(ClassMetadata $metadata, $data, array $type, Context $context)
    {
        $rs = $this->data;
        $this->data = $this->dataStack->pop();

        // Force JSON output to "{}" instead of "[]" if it contains either no properties or all properties are null.
        if (empty($rs)) {
            $rs = new \ArrayObject();

        }

        if ($this->root instanceof \stdClass && 0 === $this->dataStack->count()) {
            $this->root = $rs;
        }

        return $rs;
    }

    public function visitProperty(PropertyMetadata $metadata, $data, Context $context)
    {
        $v = $this->accessor->getValue($data, $metadata);

        $v = $this->navigator->accept($v, $metadata->type, $context);
        if (null === $v && $context->shouldSerializeNull() !== true){
            return;
        }

        if (true === $metadata->skipWhenEmpty) {
           if (($v instanceof \ArrayObject || \is_array($v)) && 0 === count($v)) {
               return;
           }
           if ('' === $v) {
            return; 
           }
        }

        if ($this->namingStrategy instanceof AdvancedNamingStrategyInterface) {
            $k = $this->namingStrategy->getPropertyName($metadata, $context);
        } else {
            $k = $this->namingStrategy->translateName($metadata);
        }

        if ($metadata->inline) {
            if (\is_array($v) || ($v instanceof \ArrayObject)) {
                $this->data = array_merge($this->data, (array) $v);
            }
        } else {
            $this->data[$k] = $v;
        }
    }

    /**
     * Allows you to add additional data to the current object/root element.
     * @deprecated use setData instead
     * @param string $key
     * @param integer|float|boolean|string|array|null $value This value must either be a regular scalar, or an array.
     *                                                       It must not contain any objects anymore.
     */
    public function addData($key, $value)
    {
        if (isset($this->data[$key])) {
            throw new InvalidArgumentException(sprintf('There is already data for "%s".', $key));
        }

        $this->data[$key] = $value;
    }

    /**
     * Checks if some data key exists.
     *
     * @param string $key
     * @return boolean
     */
    public function hasData($key)
    {
        return isset($this->data[$key]);
    }

    /**
     * Allows you to replace existing data on the current object/root element.
     *
     * @param string $key
     * @param integer|float|boolean|string|array|null $value This value must either be a regular scalar, or an array.
     *                                                       It must not contain any objects anymore.
     */
    public function setData($key, $value)
    {
        $this->data[$key] = $value;
    }

    public function getRoot()
    {
        return $this->root;
    }

    /**
     * @param array|\ArrayObject $data the passed data must be understood by whatever encoding function is applied later.
     */
    public function setRoot($data)
    {
        $this->root = $data;
    }


    public function getResult()
    {
        $result = @json_encode($this->getRoot(), $this->options);

        switch (json_last_error()) {
            case JSON_ERROR_NONE:
                return $result;

            case JSON_ERROR_UTF8:
                throw new \RuntimeException('Your data could not be encoded because it contains invalid UTF8 characters.');

            default:
                throw new \RuntimeException(sprintf('An error occurred while encoding your data (error code %d).', json_last_error()));
        }
    }

    public function getOptions()
    {
        return $this->options;
    }

    public function setOptions($options)
    {
        $this->options = (integer)$options;
    }
}


1		<?php
2
3		/*
4		* Copyright 2016 Johannes M. Schmitt <[email protected]>
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License");
7		* you may not use this file except in compliance with the License.
8		* You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS,
14		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15		* See the License for the specific language governing permissions and
16		* limitations under the License.
17		*/
18
19		namespace JMS\Serializer;
20
21		use JMS\Serializer\Exception\InvalidArgumentException;
22		use JMS\Serializer\Metadata\ClassMetadata;
23		use JMS\Serializer\Metadata\PropertyMetadata;
24		use JMS\Serializer\Naming\AdvancedNamingStrategyInterface;
25
26		class JsonSerializationVisitor extends GenericSerializationVisitor
		0 ignored issues – show Deprecated Code introduced 2017-04-21 11:52 UTC by Report Bug Copy Issue Report The class `JMS\Serializer\GenericSerializationVisitor` has been deprecated. This class, trait or interface has been deprecated. Loading history...
27		{
28		private $options = 0;
29
30		private $navigator;
		0 ignored issues – show Comprehensibility introduced 2017-04-21 11:52 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
31		private $root;
		0 ignored issues – show Comprehensibility introduced 2017-04-21 11:52 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
32		private $dataStack;
		0 ignored issues – show Comprehensibility introduced 2017-04-21 11:52 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
33		private $data;
		0 ignored issues – show Comprehensibility introduced 2017-04-21 11:52 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
34
35	148	public function setNavigator(GraphNavigator $navigator)
36		{
37	148	$this->navigator = $navigator;
38	148	$this->root = null;
39	148	$this->dataStack = new \SplStack;
40	148	}
41
42		/**
43		* @return GraphNavigator
44		*/
45		public function getNavigator()
46		{
47		return $this->navigator;
48		}
49
50	29	public function visitNull($data, array $type, Context $context)
51		{
52	29	return null;
53		}
54
55	92	public function visitString($data, array $type, Context $context)
56		{
57	92	if (null === $this->root) {
58	9	$this->root = $data;
59		}
60
61	92	return (string)$data;
62		}
63
64	9	public function visitBoolean($data, array $type, Context $context)
65		{
66	9	if (null === $this->root) {
67	5	$this->root = $data;
68		}
69
70	9	return (boolean)$data;
71		}
72
73	26	public function visitInteger($data, array $type, Context $context)
74		{
75	26	if (null === $this->root) {
76	4	$this->root = $data;
77		}
78
79	26	return (int)$data;
80		}
81
82	13	public function visitDouble($data, array $type, Context $context)
83		{
84	13	if (null === $this->root) {
85	7	$this->root = $data;
86		}
87
88	13	return (float)$data;
89		}
90
91		/**
92		* @param array $data
93		* @param array $type
94		* @param Context $context
95		* @return mixed
96		*/
97	71	public function visitArray($data, array $type, Context $context)
98		{
99	71	$this->dataStack->push($data);
100
101	71	$isHash = isset($type['params'][1]);
102
103	71	if (null === $this->root) {
104	49	$this->root = $isHash ? new \ArrayObject() : array();
105	49	$rs = &$this->root;
106		} else {
107	24	$rs = $isHash ? new \ArrayObject() : array();
108		}
109
110	71	$isList = isset($type['params'][0]) && !isset($type['params'][1]);
111
112	71	foreach ($data as $k => $v) {
113	65	$v = $this->navigator->accept($v, $this->getElementType($type), $context);
114
115	65	if (null === $v && $context->shouldSerializeNull() !== true) {
116	3	continue;
117		}
118
119	65	if ($isList) {
120	17	$rs[] = $v;
121		} else {
122	65	$rs[$k] = $v;
123		}
124		}
125
126	71	$this->dataStack->pop();
127	71	return $rs;
128		}
129
130	85	public function startVisitingObject(ClassMetadata $metadata, $data, array $type, Context $context)
131		{
132	85	if (null === $this->root) {
133	70	$this->root = new \stdClass;
134		}
135
136	85	$this->dataStack->push($this->data);
137	85	$this->data = array();
138	85	}
139
140	84	public function endVisitingObject(ClassMetadata $metadata, $data, array $type, Context $context)
141		{
142	84	$rs = $this->data;
143	84	$this->data = $this->dataStack->pop();
144
145		// Force JSON output to "{}" instead of "[]" if it contains either no properties or all properties are null.
146	84	if (empty($rs)) {
147	12	$rs = new \ArrayObject();
		0 ignored issues – show Bug Compatibility introduced 2017-04-21 14:11 UTC by Report Bug Copy Issue Report The expression `new \ArrayObject();` of type `ArrayObject` adds the type `ArrayObject` to the return on line 154 which is incompatible with the return type of the parent method `JMS\Serializer\GenericSe...itor::endVisitingObject` of type `array`. Loading history...
148		}
149
150	84	if ($this->root instanceof \stdClass && 0 === $this->dataStack->count()) {
151	69	$this->root = $rs;
152		}
153
154	84	return $rs;
155		}
156
157	81	public function visitProperty(PropertyMetadata $metadata, $data, Context $context)
158		{
159	81	$v = $this->accessor->getValue($data, $metadata);
160
161	80	$v = $this->navigator->accept($v, $metadata->type, $context);
162	80	if (null === $v && $context->shouldSerializeNull() !== true){
163	16	return;
164		}
165
166	78	if (true === $metadata->skipWhenEmpty) {
167	3	if (($v instanceof \ArrayObject \|\| \is_array($v)) && 0 === count($v)) {
168	3	return;
169		}
170	1	if ('' === $v) {
171	1	return;
172		}
173		}
174
175	76	if ($this->namingStrategy instanceof AdvancedNamingStrategyInterface) {
176	1	$k = $this->namingStrategy->getPropertyName($metadata, $context);
177		} else {
178	75	$k = $this->namingStrategy->translateName($metadata);
179		}
180
181	76	if ($metadata->inline) {
182	3	if (\is_array($v) \|\| ($v instanceof \ArrayObject)) {
183	3	$this->data = array_merge($this->data, (array) $v);
184		}
185		} else {
186	75	$this->data[$k] = $v;
187		}
188	76	}
189
190		/**
191		* Allows you to add additional data to the current object/root element.
192		* @deprecated use setData instead
193		* @param string $key
194		* @param integer\|float\|boolean\|string\|array\|null $value This value must either be a regular scalar, or an array.
195		* It must not contain any objects anymore.
196		*/
197	1	public function addData($key, $value)
198		{
199	1	if (isset($this->data[$key])) {
200		throw new InvalidArgumentException(sprintf('There is already data for "%s".', $key));
201		}
202
203	1	$this->data[$key] = $value;
204	1	}
205
206		/**
207		* Checks if some data key exists.
208		*
209		* @param string $key
210		* @return boolean
211		*/
212	1	public function hasData($key)
213		{
214	1	return isset($this->data[$key]);
215		}
216
217		/**
218		* Allows you to replace existing data on the current object/root element.
219		*
220		* @param string $key
221		* @param integer\|float\|boolean\|string\|array\|null $value This value must either be a regular scalar, or an array.
222		* It must not contain any objects anymore.
223		*/
224	1	public function setData($key, $value)
225		{
226	1	$this->data[$key] = $value;
227	1	}
228
229	149	public function getRoot()
230		{
231	149	return $this->root;
232		}
233
234		/**
235		* @param array\|\ArrayObject $data the passed data must be understood by whatever encoding function is applied later.
236		*/
237	8	public function setRoot($data)
238		{
239	8	$this->root = $data;
240	8	}
241
242
243	137	public function getResult()
244		{
245	137	$result = @json_encode($this->getRoot(), $this->options);
246
247	137	switch (json_last_error()) {
248	137	case JSON_ERROR_NONE:
249	135	return $result;
250
251	2	case JSON_ERROR_UTF8:
252	2	throw new \RuntimeException('Your data could not be encoded because it contains invalid UTF8 characters.');
253
254		default:
255		throw new \RuntimeException(sprintf('An error occurred while encoding your data (error code %d).', json_last_error()));
256		}
257		}
258
259		public function getOptions()
260		{
261		return $this->options;
262		}
263
264		public function setOptions($options)
265		{
266		$this->options = (integer)$options;
267		}
268		}
269

schmittjoh / serializer

Pull Request — master (#883)

JsonSerializationVisitor::visitString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like