XmlRenderer::_array() - Code Metrics - CakeDC/cakephp-api - Measure and Improve Code Quality continuously with Scrutinizer

XmlRenderer::_array() B
last analyzed 2021-05-07 09:37 UTC

↳ Parent: XmlRenderer

Complexity

Conditions	6
Paths	10

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	42

Importance

Changes

Metric	Value
cc	6
nc	10
nop	1
dl	0
loc	27
rs	8.8657
c	0
b	0
f	0
ccs	0
cts	22
cp	0
crap	42

<?php
/**
 * Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
 * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
 */

namespace CakeDC\Api\Service\Renderer;

use CakeDC\Api\Exception\ValidationException;
use CakeDC\Api\Service\Action\Result;
use Cake\Collection\Collection;
use Cake\Core\Configure;
use Cake\Datasource\EntityInterface;
use Cake\Datasource\ResultSetInterface;
use Cake\I18n\FrozenTime;
use Cake\Utility\Xml;
use Exception;

/**
 * Class XmlRenderer
 * XML content negotiation Renderer.
 *
 * @package CakeDC\Api\Service\Renderer
 */
class XmlRenderer extends BaseRenderer
{

    /**
     * Builds the HTTP response.
     *
     * @param Result $result The result object returned by the Service.
     * @return bool
     */
    public function response(Result $result = null)
    {
        $response = $this->_service->getResponse();
        $xml = $this->_format($result->getData());
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
        $this->_service->setResponse($response->withStringBody($this->_encode($xml))->withType('application/xml')
            ->withStatus($result->getCode()));

        return true;
    }

    /**
     * Processes an exception thrown while processing the request.
     *
     * @param Exception $exception The exception object.
     * @return void
     */
    public function error(Exception $exception)
    {
        $response = $this->_service->getResponse();
        $data = [
            'error' => [
                'code' => $exception->getCode(),
                'message' => $this->_buildMessage($exception)
            ]
        ];
        if (Configure::read('debug') > 0) {
            $data['error']['trace'] = $this->_stackTrace($exception);
        }
        if ($exception instanceof ValidationException) {
            $data['error']['validation'] = $exception->getValidationErrors();
        }
        $this->_service->setResponse($response->withStringBody($this->_encode($data))->withType('application/xml'));
    }

    /**
     * Formats a response as an XML structure.
     *
     * @param mixed $content The content to process.
     * @return string
     */
    protected function _format($content = null)
    {
        if (is_array($content) || $content instanceof Collection || $content instanceof ResultSetInterface) {
            $data = $this->_array($content);

        } elseif (is_object($content)) {
            $data = $this->_object($content);
        } else {
            $data = ['value' => $content];
        }

        return ['data' => $data];
    }

    /**
     * Formats an object as an XML node.
     *
     * @param object $data The object to process.
     * @return string
     */
    protected function _object($data)
    {
        $xml = [];
        if ($data instanceof EntityInterface) {
            $data = $data->toArray();
        }
        foreach ($data as $name => $value) {
            if (is_object($value) && $value instanceof \DateTime) {
                $property = [];
                $property['@'] = $value->format(\DateTime::ISO8601);
            } elseif (is_object($value) && $value instanceof FrozenTime) {
                $property = [];
                $property['@'] = $value->toIso8601String();
            } elseif (is_object($value)) {
                $property = $this->_object($value);
            } elseif (is_array($value)) {
                    $property = $this->_array($value);
            } else {
                $property = [];
                $property['@'] = $value !== null ? $value : '';
            }
            $property['@name'] = $name;
            $xml['property'][] = $property;
        }

        return ['object' => $xml];
    }

    /**
     * Formats an array as an XML node.
     *
     * @param array $data The array to process.
     * @return string
     */
    protected function _array($data)
    {
        $xml = [];
        $items = [];
        if ($data instanceof Collection) {
            $data = $data->toArray();
        }
        foreach ($data as $name => $value) {
            $item = [];
            $item['@key'] = $name;
            if (is_object($value)) {
                $item = $this->_object($value);
            } else {
                if (is_array($value)) {
                    $item = $this->_array($value);
                } else {
                    $item = [];
                    $item['@'] = $value !== null ? $value : '';
                }
            }
            $item['@key'] = $name;
            $items[] = $item;
        }
        $xml['array']['row'] = $items;

        return $xml;
    }

    /**
     * Encoded object as xml.
     *
     * @param mixed $data Encoded data.
     * @return string
     */
    protected function _encode($data)
    {
        $xmlObject = Xml::fromArray($data, ['format' => 'tags']);

        return $xmlObject->asXML();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }
}


1		<?php
2		/**
3		* Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
4		*
5		* Licensed under The MIT License
6		* Redistributions of files must retain the above copyright notice.
7		*
8		* @copyright Copyright 2016 - 2018, Cake Development Corporation (http://cakedc.com)
9		* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
10		*/
11
12		namespace CakeDC\Api\Service\Renderer;
13
14		use CakeDC\Api\Exception\ValidationException;
15		use CakeDC\Api\Service\Action\Result;
16		use Cake\Collection\Collection;
17		use Cake\Core\Configure;
18		use Cake\Datasource\EntityInterface;
19		use Cake\Datasource\ResultSetInterface;
20		use Cake\I18n\FrozenTime;
21		use Cake\Utility\Xml;
22		use Exception;
23
24		/**
25		* Class XmlRenderer
26		* XML content negotiation Renderer.
27		*
28		* @package CakeDC\Api\Service\Renderer
29		*/
30		class XmlRenderer extends BaseRenderer
31		{
32
33		/**
34		* Builds the HTTP response.
35		*
36		* @param Result $result The result object returned by the Service.
37		* @return bool
38		*/
39	1	public function response(Result $result = null)
40		{
41	1	$response = $this->_service->getResponse();
42	1	$xml = $this->_format($result->getData());
		0 ignored issues – show Bug introduced 2018-02-26 16:21 UTC by Report Bug Copy Issue Report It seems like `$result` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
43	1	$this->_service->setResponse($response->withStringBody($this->_encode($xml))->withType('application/xml')
44	1	->withStatus($result->getCode()));
45
46	1	return true;
47		}
48
49		/**
50		* Processes an exception thrown while processing the request.
51		*
52		* @param Exception $exception The exception object.
53		* @return void
54		*/
55	1	public function error(Exception $exception)
56		{
57	1	$response = $this->_service->getResponse();
58		$data = [
59		'error' => [
60	1	'code' => $exception->getCode(),
61	1	'message' => $this->_buildMessage($exception)
62	1	]
63	1	];
64	1	if (Configure::read('debug') > 0) {
65		$data['error']['trace'] = $this->_stackTrace($exception);
66		}
67	1	if ($exception instanceof ValidationException) {
68		$data['error']['validation'] = $exception->getValidationErrors();
69		}
70	1	$this->_service->setResponse($response->withStringBody($this->_encode($data))->withType('application/xml'));
71	1	}
72
73		/**
74		* Formats a response as an XML structure.
75		*
76		* @param mixed $content The content to process.
77		* @return string
78		*/
79	1	protected function _format($content = null)
80		{
81	1	if (is_array($content) \|\| $content instanceof Collection \|\| $content instanceof ResultSetInterface) {
82		$data = $this->_array($content);
		0 ignored issues – show Bug introduced 2016-11-14 17:33 UTC by Report Bug Copy Issue Report It seems like `$content` defined by parameter `$content` on line 79 can also be of type `object<Cake\Collection\Collection>` or `object<Cake\Datasource\ResultSetInterface>`; however, `CakeDC\Api\Service\Renderer\XmlRenderer::_array()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
83	1	} elseif (is_object($content)) {
84		$data = $this->_object($content);
85		} else {
86	1	$data = ['value' => $content];
87		}
88
89	1	return ['data' => $data];
90		}
91
92		/**
93		* Formats an object as an XML node.
94		*
95		* @param object $data The object to process.
96		* @return string
97		*/
98		protected function _object($data)
99		{
100		$xml = [];
101		if ($data instanceof EntityInterface) {
102		$data = $data->toArray();
103		}
104		foreach ($data as $name => $value) {
105		if (is_object($value) && $value instanceof \DateTime) {
106		$property = [];
107		$property['@'] = $value->format(\DateTime::ISO8601);
108		} elseif (is_object($value) && $value instanceof FrozenTime) {
109		$property = [];
110		$property['@'] = $value->toIso8601String();
111		} elseif (is_object($value)) {
112		$property = $this->_object($value);
113		} elseif (is_array($value)) {
114		$property = $this->_array($value);
115		} else {
116		$property = [];
117		$property['@'] = $value !== null ? $value : '';
118		}
119		$property['@name'] = $name;
120		$xml['property'][] = $property;
121		}
122
123		return ['object' => $xml];
124		}
125
126		/**
127		* Formats an array as an XML node.
128		*
129		* @param array $data The array to process.
130		* @return string
131		*/
132		protected function _array($data)
133		{
134		$xml = [];
135		$items = [];
136		if ($data instanceof Collection) {
137		$data = $data->toArray();
138		}
139		foreach ($data as $name => $value) {
140		$item = [];
141		$item['@key'] = $name;
142		if (is_object($value)) {
143		$item = $this->_object($value);
144		} else {
145		if (is_array($value)) {
146		$item = $this->_array($value);
147		} else {
148		$item = [];
149		$item['@'] = $value !== null ? $value : '';
150		}
151		}
152		$item['@key'] = $name;
153		$items[] = $item;
154		}
155		$xml['array']['row'] = $items;
156
157		return $xml;
158		}
159
160		/**
161		* Encoded object as xml.
162		*
163		* @param mixed $data Encoded data.
164		* @return string
165		*/
166	2	protected function _encode($data)
167		{
168	2	$xmlObject = Xml::fromArray($data, ['format' => 'tags']);
169
170	2	return $xmlObject->asXML();
		0 ignored issues – show Bug introduced 2016-11-14 17:33 UTC by Report Bug Copy Issue Report The method `asXML` does only exist in `SimpleXMLElement`, but not in `DOMDocument`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
171		}
172		}
173

CakeDC / cakephp-api

XmlRenderer::_array() B last analyzed 2021-05-07 09:37 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

XmlRenderer::_array() B
last analyzed 2021-05-07 09:37 UTC