Issue::__construct() - Code Metrics - Inspection of "Codeclimate plugin" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#210)

by Дмитрий

created 2016-10-08 06:50 UTC

Issue::__construct() A

↳ Parent: Issue

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	4
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * @author Patsura Dmitry https://github.com/ovr <[email protected]>
 */

namespace PHPSA;

class Issue
{
    /**
     * @todo Description
     *
     * @var string
     */
    const CATEGORY_BUG_RISK = 'Bug Risk';

    /**
     * @todo Description
     *
     * @var string
     */
    const CATEGORY_Clarity = 'Clarity';


    /**
     * @todo Description
     *
     * @var string
     */
    const CATEGORY_Compatibility = 'Compatibility';


    /**
     * @todo Description
     *
     * @var string
     */
    const CATEGORY_Complexity = 'Complexity';


    /**
     * @todo Description
     *
     * @var string
     */
    const CATEGORY_Duplication = 'Duplication';


    /**
     * @todo Description
     *
     * @var string
     */
    const CATEGORY_Performance = 'Performance';


    /**
     * @todo Description
     *
     * @var string
     */
    const CATEGORY_Security = 'Security';


    /**
     * @todo Description
     *
     * @var string
     */
    const CATEGORY_Style = 'Style';


    /**
     * Required. Must always be "issue".
     *
     * @var string
     */
    protected $type = 'issue';

    /**
     * Required. A unique name representing the static analysis check that emitted this issue.
     *
     * @var string
     */
    protected $checkName;

    /**
     * Required. A string explaining the issue that was detected.
     *
     * @var string
     */
    protected $description;

    /**
     * Optional. A markdown snippet describing the issue, including deeper explanations and links to other resources.
     *
     * @var string
     */
    protected $content;

    /**
     * Required. At least one category indicating the nature of the issue being reported.
     *
     * @var string
     */
    protected $categories;

    /**
     * Required. A Location object representing the place in the source code where the issue was discovered.
     *
     * @var string
     */
    protected $location;

    /**
     * @param string $checkName
     * @param string $description
     * @param array $location
     * @param array $categories
     */
    public function __construct($checkName, $description, array $location, array $categories = [self::CATEGORY_BUG_RISK])
    {
        $this->checkName = $checkName;
        $this->description = $description;
        $this->location = $location;

        $this->categories = $categories;

    }

    public function toArray()
    {
        return [
            'type' => $this->type,
            'description' => $this->description,
            'location' => $this->location,
            'categories' => $this->categories,
        ];
    }
}


1			<?php
2			/**
3			* @author Patsura Dmitry https://github.com/ovr <[email protected]>
4			*/
5
6			namespace PHPSA;
7
8			class Issue
9			{
10			/**
11			* @todo Description
12			*
13			* @var string
14			*/
15			const CATEGORY_BUG_RISK = 'Bug Risk';
16
17			/**
18			* @todo Description
19			*
20			* @var string
21			*/
22			const CATEGORY_Clarity = 'Clarity';
			0 ignored issues – show Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report Constant CATEGORY_Clarity should be defined in uppercase Loading history... Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report This class constant is not uppercase (expected `CATEGORY_CLARITY`). Loading history...
23
24			/**
25			* @todo Description
26			*
27			* @var string
28			*/
29			const CATEGORY_Compatibility = 'Compatibility';
			0 ignored issues – show Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report Constant CATEGORY_Compatibility should be defined in uppercase Loading history... Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report This class constant is not uppercase (expected `CATEGORY_COMPATIBILITY`). Loading history...
30
31			/**
32			* @todo Description
33			*
34			* @var string
35			*/
36			const CATEGORY_Complexity = 'Complexity';
			0 ignored issues – show Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report Constant CATEGORY_Complexity should be defined in uppercase Loading history... Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report This class constant is not uppercase (expected `CATEGORY_COMPLEXITY`). Loading history...
37
38			/**
39			* @todo Description
40			*
41			* @var string
42			*/
43			const CATEGORY_Duplication = 'Duplication';
			0 ignored issues – show Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report Constant CATEGORY_Duplication should be defined in uppercase Loading history... Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report This class constant is not uppercase (expected `CATEGORY_DUPLICATION`). Loading history...
44
45			/**
46			* @todo Description
47			*
48			* @var string
49			*/
50			const CATEGORY_Performance = 'Performance';
			0 ignored issues – show Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report Constant CATEGORY_Performance should be defined in uppercase Loading history... Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report This class constant is not uppercase (expected `CATEGORY_PERFORMANCE`). Loading history...
51
52			/**
53			* @todo Description
54			*
55			* @var string
56			*/
57			const CATEGORY_Security = 'Security';
			0 ignored issues – show Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report Constant CATEGORY_Security should be defined in uppercase Loading history... Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report This class constant is not uppercase (expected `CATEGORY_SECURITY`). Loading history...
58
59			/**
60			* @todo Description
61			*
62			* @var string
63			*/
64			const CATEGORY_Style = 'Style';
			0 ignored issues – show Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report Constant CATEGORY_Style should be defined in uppercase Loading history... Coding Style introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report This class constant is not uppercase (expected `CATEGORY_STYLE`). Loading history...
65
66			/**
67			* Required. Must always be "issue".
68			*
69			* @var string
70			*/
71			protected $type = 'issue';
72
73			/**
74			* Required. A unique name representing the static analysis check that emitted this issue.
75			*
76			* @var string
77			*/
78			protected $checkName;
79
80			/**
81			* Required. A string explaining the issue that was detected.
82			*
83			* @var string
84			*/
85			protected $description;
86
87			/**
88			* Optional. A markdown snippet describing the issue, including deeper explanations and links to other resources.
89			*
90			* @var string
91			*/
92			protected $content;
93
94			/**
95			* Required. At least one category indicating the nature of the issue being reported.
96			*
97			* @var string
98			*/
99			protected $categories;
100
101			/**
102			* Required. A Location object representing the place in the source code where the issue was discovered.
103			*
104			* @var string
105			*/
106			protected $location;
107
108			/**
109			* @param string $checkName
110			* @param string $description
111			* @param array $location
112			* @param array $categories
113			*/
114			public function __construct($checkName, $description, array $location, array $categories = [self::CATEGORY_BUG_RISK])
115			{
116			$this->checkName = $checkName;
117			$this->description = $description;
118			$this->location = $location;
			0 ignored issues – show Documentation Bug introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report It seems like `$location` of type `array` is incompatible with the declared type `string` of property `$location`. 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...
119			$this->categories = $categories;
			0 ignored issues – show Documentation Bug introduced 2016-10-08 06:53 UTC by Report Bug Copy Issue Report It seems like `$categories` of type `array` is incompatible with the declared type `string` of property `$categories`. 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...
120			}
121
122			public function toArray()
123			{
124			return [
125			'type' => $this->type,
126			'description' => $this->description,
127			'location' => $this->location,
128			'categories' => $this->categories,
129			];
130			}
131			}
132

ovr / phpsa

Pull Request — master (#210)

Issue::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like