ApiDoc::buildStatusCodes() - Code Metrics - kreta/SimpleApiDocBundle - Measure and Improve Code Quality continuously with Scrutinizer

ApiDoc::buildStatusCodes() A
last analyzed 2016-04-15 16:11 UTC

↳ Parent: ApiDoc

Complexity

Conditions	4
Paths	2

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
c	4
b	0
f	0
dl	0
loc	15
rs	9.2
cc	4
eloc	9
nc	2
nop	1

<?php

/*
 * This file is part of the Kreta package.
 *
 * (c) Beñat Espiña <[email protected]>
 * (c) Gorka Laucirica <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Kreta\SimpleApiDocBundle\Annotation;

use Nelmio\ApiDocBundle\Annotation\ApiDoc as BaseApiDoc;

/**
 * Api doc class.
 *
 * @author Beñat Espiña <[email protected]>
 *
 * @Annotation()
 */
class ApiDoc extends BaseApiDoc
{
    /**
     * Array that contains default descriptions of each status code.
     *
     * @var array
     */
    protected $defaultStatusCodes = [
        200 => '<data>',
        201 => '<data>',
        204 => '',
        403 => 'Not allowed to access this resource',
        404 => 'Does not exist any object with id passed',
        409 => 'The resource is currently in use',
    ];

    /**
     * Array that contains the format of the Api.
     *
     * @var array
     */
    protected $format = [
        'requirement' => 'json|jsonp',
        'description' => 'Supported formats, by default json',
    ];

    /**
     * Constructor.
     *
     * @param array $data The data
     */
    public function __construct(array $data)
    {
        parent::__construct($data);
        $this->buildStatusCodes($data);
        $this->addRequirement('_format', $this->format);
    }

    /**
     * Loads data given status codes.
     *
     * @param array $data Array that contains all the data
     *
     * @return self
     */
    protected function buildStatusCodes(array $data)
    {
        if (isset($data['statusCodes'])) {
            $this->initializeStatusCodes();
            foreach ($data['statusCodes'] as $key => $element) {
                if ((int) $key < 200) {
                    $this->statusCodes($element);
                } else {
                    $this->statusCodes($key, $element);
                }
            }
        }

        return $this;
    }

    /**
     * Method that allows to choose between status
     * code passing the code and optional description.
     *
     * @param int         $statusCode        The status code
     * @param string|null $customDescription The description
     *
     * @return self
     */
    protected function statusCodes($statusCode, $customDescription = null)
    {
        if ($customDescription) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $description = $customDescription;
        }
        if ($customDescription !== null || array_key_exists($statusCode, $this->defaultStatusCodes)) {
            if (!isset($description)) {
                $description = $this->defaultStatusCodes[$statusCode];
            }
            $description = !is_array($description) ? [$description] : $description;
            $this->addStatusCode($statusCode, $description);
        }

        return $this;
    }

    /**
     * Purges the statusCodes array to populate with the new way.
     *
     * This method is required because the $statusCodes
     * is a private field, and the reflection is necessary.
     * 
     * @return self
     */
    protected function initializeStatusCodes()
    {
        $annotationReflection = new \ReflectionClass('Nelmio\ApiDocBundle\Annotation\ApiDoc');
        $statusCodesReflection = $annotationReflection->getProperty('statusCodes');
        $statusCodesReflection->setAccessible(true);
        $statusCodesReflection->setValue($this, []);

        return $this;
    }
}


1			<?php
2
3			/*
4			* This file is part of the Kreta package.
5			*
6			* (c) Beñat Espiña <[email protected]>
7			* (c) Gorka Laucirica <[email protected]>
8			*
9			* For the full copyright and license information, please view the LICENSE
10			* file that was distributed with this source code.
11			*/
12
13			namespace Kreta\SimpleApiDocBundle\Annotation;
14
15			use Nelmio\ApiDocBundle\Annotation\ApiDoc as BaseApiDoc;
16
17			/**
18			* Api doc class.
19			*
20			* @author Beñat Espiña <[email protected]>
21			*
22			* @Annotation()
23			*/
24			class ApiDoc extends BaseApiDoc
25			{
26			/**
27			* Array that contains default descriptions of each status code.
28			*
29			* @var array
30			*/
31			protected $defaultStatusCodes = [
32			200 => '<data>',
33			201 => '<data>',
34			204 => '',
35			403 => 'Not allowed to access this resource',
36			404 => 'Does not exist any object with id passed',
37			409 => 'The resource is currently in use',
38			];
39
40			/**
41			* Array that contains the format of the Api.
42			*
43			* @var array
44			*/
45			protected $format = [
46			'requirement' => 'json\|jsonp',
47			'description' => 'Supported formats, by default json',
48			];
49
50			/**
51			* Constructor.
52			*
53			* @param array $data The data
54			*/
55			public function __construct(array $data)
56			{
57			parent::__construct($data);
58			$this->buildStatusCodes($data);
59			$this->addRequirement('_format', $this->format);
60			}
61
62			/**
63			* Loads data given status codes.
64			*
65			* @param array $data Array that contains all the data
66			*
67			* @return self
68			*/
69			protected function buildStatusCodes(array $data)
70			{
71			if (isset($data['statusCodes'])) {
72			$this->initializeStatusCodes();
73			foreach ($data['statusCodes'] as $key => $element) {
74			if ((int) $key < 200) {
75			$this->statusCodes($element);
76			} else {
77			$this->statusCodes($key, $element);
78			}
79			}
80			}
81
82			return $this;
83			}
84
85			/**
86			* Method that allows to choose between status
87			* code passing the code and optional description.
88			*
89			* @param int $statusCode The status code
90			* @param string\|null $customDescription The description
91			*
92			* @return self
93			*/
94			protected function statusCodes($statusCode, $customDescription = null)
95			{
96			if ($customDescription) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-16 12:36 UTC by Report Bug Copy Issue Report The expression `$customDescription` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
97			$description = $customDescription;
98			}
99			if ($customDescription !== null \|\| array_key_exists($statusCode, $this->defaultStatusCodes)) {
100			if (!isset($description)) {
101			$description = $this->defaultStatusCodes[$statusCode];
102			}
103			$description = !is_array($description) ? [$description] : $description;
104			$this->addStatusCode($statusCode, $description);
105			}
106
107			return $this;
108			}
109
110			/**
111			* Purges the statusCodes array to populate with the new way.
112			*
113			* This method is required because the $statusCodes
114			* is a private field, and the reflection is necessary.
115			*
116			* @return self
117			*/
118			protected function initializeStatusCodes()
119			{
120			$annotationReflection = new \ReflectionClass('Nelmio\ApiDocBundle\Annotation\ApiDoc');
121			$statusCodesReflection = $annotationReflection->getProperty('statusCodes');
122			$statusCodesReflection->setAccessible(true);
123			$statusCodesReflection->setValue($this, []);
124
125			return $this;
126			}
127			}
128

kreta / SimpleApiDocBundle

ApiDoc::buildStatusCodes() A last analyzed 2016-04-15 16:11 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ApiDoc::buildStatusCodes() A
last analyzed 2016-04-15 16:11 UTC