Response::success() - Code Metrics - Inspection of "Add success response" - normeno/gjson - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (40005c)

by Nicolas

created 2017-11-07 15:26 UTC

Response::success() A

↳ Parent: Response

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	9
ccs	5
cts	5
cp	1
rs	9.6666
cc	1
eloc	5
nc	1
nop	1
crap	1

<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */

/**
 * This file is part of the Gjson library.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * PHP Version 5, 7
 *
 * LICENSE: This source file is subject to the MIT license that is available
 * through the world-wide-web at the following URI:
 * http://opensource.org/licenses/mit-license.php
 *
 * @category Src
 * @package  Normeno\Gjson
 * @author   Nicolas Ormeno <[email protected]>
 * @license  http://opensource.org/licenses/mit-license.php MIT License
 * @link     https://github.com/normeno/gjson
 */

namespace Normeno\Gjson;

/**
 * Tests for Format
 *
 * @category Src
 * @package  Normeno\Gjson
 * @author   Nicolas Ormeno <[email protected]>
 * @license  http://opensource.org/licenses/mit-license.php MIT License
 * @link     https://github.com/normeno/gjson
 */
class Response
{
    /**
     * Api Version
     *
     * @var string number of version
     */
    private $apiVersion;

    /**
     * Api Context
     *
     * @var string name of context
     */
    private $context;

    /**
     * Output Format
     *
     * @var string json|array|object
     */
    private $format;

    /**
     * Response constructor.
     *
     * @param string $apiVersion number of version
     * @param string $context    name of context
     * @param string $format     json|array|object
     */
    public function __construct($apiVersion = '1.0', $context = 'api', $format = 'json')
    {
        $this->apiVersion  = $apiVersion;
        $this->context     = $context;
        $this->format      = $format;
    }

    /**
     * Generate error response
     *
     * @param integer $code  number of error
     * @param string  $msg   message to identify error
     * @param array   $extra extra data
     *
     * @return array|object|string
     */
    public function error($code, $msg, $extra = [])
    {
        $error = [
            'error' => [
                'code'      => $code,
                'message'   => $msg
            ]
        ];

        if (!empty($extra)) {
            $extraErrors = (array_key_exists('errors', $extra)) ? $extra['errors'] : $extra;
            $error['error']['errors'] = $extraErrors;
        }

        $response = $this->basicStructure() + $error;
        return $this->output($response);
    }

    /**
     * Generate success response
     *
     * @param array   $data data
     *
     * @return array|object|string
     */
    public function success($data)
    {
        $success = [
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            'items' => $data
        ];

        $response = $this->basicStructure() + $data;
        return $this->output($response);
    }

    /**
     * Generate basic structure
     *
     * This structure is used in all the responses
     *
     * @return array
     */
    private function basicStructure()
    {
        return [
            'apiVersion'    => $this->apiVersion,
            'context'       => $this->context
        ];
    }

    /**
     * Generate output
     *
     * @param array|object $data output data
     *
     * @return array|object|string
     */
    private function output($data)
    {
        switch ($this->format) {
            case 'array':
                return (array)$data;
            case 'object':
                return (object)$data;
            case 'json':
                return json_encode($data);
            default:
                return json_encode($data);
        }
    }
}


1		<?php
2		/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
3
4		/**
5		* This file is part of the Gjson library.
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*
10		* PHP Version 5, 7
11		*
12		* LICENSE: This source file is subject to the MIT license that is available
13		* through the world-wide-web at the following URI:
14		* http://opensource.org/licenses/mit-license.php
15		*
16		* @category Src
17		* @package Normeno\Gjson
18		* @author Nicolas Ormeno <[email protected]>
19		* @license http://opensource.org/licenses/mit-license.php MIT License
20		* @link https://github.com/normeno/gjson
21		*/
22
23		namespace Normeno\Gjson;
24
25		/**
26		* Tests for Format
27		*
28		* @category Src
29		* @package Normeno\Gjson
30		* @author Nicolas Ormeno <[email protected]>
31		* @license http://opensource.org/licenses/mit-license.php MIT License
32		* @link https://github.com/normeno/gjson
33		*/
34		class Response
35		{
36		/**
37		* Api Version
38		*
39		* @var string number of version
40		*/
41		private $apiVersion;
42
43		/**
44		* Api Context
45		*
46		* @var string name of context
47		*/
48		private $context;
49
50		/**
51		* Output Format
52		*
53		* @var string json\|array\|object
54		*/
55		private $format;
56
57		/**
58		* Response constructor.
59		*
60		* @param string $apiVersion number of version
61		* @param string $context name of context
62		* @param string $format json\|array\|object
63		*/
64		public function __construct($apiVersion = '1.0', $context = 'api', $format = 'json')
65		{
66		$this->apiVersion = $apiVersion;
67		$this->context = $context;
68		$this->format = $format;
69		}
70
71		/**
72		* Generate error response
73		*
74		* @param integer $code number of error
75		* @param string $msg message to identify error
76		* @param array $extra extra data
77		*
78		* @return array\|object\|string
79		*/
80	6	public function error($code, $msg, $extra = [])
81		{
82		$error = [
83		'error' => [
84	6	'code' => $code,
85	2	'message' => $msg
86	4	]
87	4	];
88
89	6	if (!empty($extra)) {
90	3	$extraErrors = (array_key_exists('errors', $extra)) ? $extra['errors'] : $extra;
91	3	$error['error']['errors'] = $extraErrors;
92	2	}
93
94	6	$response = $this->basicStructure() + $error;
95	6	return $this->output($response);
96		}
97
98		/**
99		* Generate success response
100		*
101		* @param array $data data
102		*
103		* @return array\|object\|string
104		*/
105	9	public function success($data)
106		{
107		$success = [
		0 ignored issues – show Unused Code introduced 2017-11-07 15:28 UTC by Report Bug Copy Issue Report `$success` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
108	3	'items' => $data
109	6	];
110
111	9	$response = $this->basicStructure() + $data;
112	9	return $this->output($response);
113		}
114
115		/**
116		* Generate basic structure
117		*
118		* This structure is used in all the responses
119		*
120		* @return array
121		*/
122	15	private function basicStructure()
123		{
124		return [
125	15	'apiVersion' => $this->apiVersion,
126	15	'context' => $this->context
127	10	];
128		}
129
130		/**
131		* Generate output
132		*
133		* @param array\|object $data output data
134		*
135		* @return array\|object\|string
136		*/
137	15	private function output($data)
138		{
139	15	switch ($this->format) {
140	15	case 'array':
141		return (array)$data;
142	15	case 'object':
143		return (object)$data;
144	15	case 'json':
145	15	return json_encode($data);
146		default:
147		return json_encode($data);
148		}
149		}
150		}
151

normeno / gjson

Branch — master (40005c)

Response::success() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like