AbstractCerberus::__construct() - Code Metrics - Inspection of "Reverted composer.json" - devtoolboxuk/cerberus - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2d3e3c...0995af )

by Rob

created 2019-05-25 20:18 UTC

AbstractCerberus::__construct() A

↳ Parent: AbstractCerberus

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	5
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

namespace devtoolboxuk\cerberus;

use devtoolboxuk\soteria\SoteriaService;

abstract class AbstractCerberus
{

    protected $options = [];
    protected $results = [];
    protected $result = [];
    protected $score = 0;
    protected $soteria;

    function __construct()

    {
        $this->soteria = new SoteriaService();
        $this->setOptions();
    }

    public function yaml_loaded()

    {
        return extension_loaded('yaml');
    }

    protected function processWrappers($handler)
    {
        $options = $this->getOption('Detection');

        foreach ($handler->getWrappers() as $wrapper) {


            $wrapper->setOptions($handler->getValue(), $options['Rules']);
            $wrapper->process();
            $this->addResult($wrapper->getScore(), $wrapper->getResult());
        }
    }

    private function getOption($name)
    {
        if (!$this->hasOption($name)) {
            return null;
        }

        return $this->options[$name];
    }

    private function hasOption($name)
    {
        return isset($this->options[$name]);
    }

    protected function addResult($score, $result)
    {
        if (is_array($result)) {
            $this->addScore($score);
            $this->result = array_merge($this->result, $result);
        }
        return $this;
    }

    /**
     * @param $score
     * @return $this
     */
    private function addScore($score)
    {
        $this->score += $score;
        return $this;
    }

    protected function clearResults()
    {
        $this->results = [];
        $this->result = [];
        $this->score = 0;
    }

    /**
     * @return array
     */
    protected function getOptions()
    {
        return $this->options;
    }

    /**
     * @param file|array $options
     * @return $this
     */
    public function setOptions($options = [])

    {
        $basic_options = [];
        if ($this->yaml_loaded()) {
            $basic_options = yaml_parse_file(__DIR__ . '/Options.yml');
        }
        if (is_array($options)) {
            $options = $this->arrayMergeRecursiveDistinct($basic_options, $options);
        } else {


            $this->soteria->sanitise()->disinfect($options, 'url');
            if ($this->soteria->sanitise()->result()->isValid()) {
                $options = $this->arrayMergeRecursiveDistinct($basic_options, yaml_parse_file($options));
            } else {

                if (file_exists($options)) {
                    $options = $this->arrayMergeRecursiveDistinct($basic_options, yaml_parse_file($options));
                }
            }
        }
        $this->options = $options;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    private function arrayMergeRecursiveDistinct($merged = [], $array2 = [])

    {
        if (empty($array2)) {
            return $merged;
        }

        foreach ($array2 as $key => &$value) {
            if (is_array($value) && isset($merged[$key]) && is_array($merged[$key])) {
                $merged[$key] = $this->arrayMergeRecursiveDistinct($merged[$key], $value);
            } else {

                $merged[$key] = $value;
            }
        }
        return $merged;
    }
}

1		<?php
2
3		namespace devtoolboxuk\cerberus;
4
5		use devtoolboxuk\soteria\SoteriaService;
6
7		abstract class AbstractCerberus
8		{
9
10		protected $options = [];
11		protected $results = [];
12		protected $result = [];
13		protected $score = 0;
14		protected $soteria;
15
16		function __construct()
		0 ignored issues – show Best Practice introduced 2019-05-25 19:55 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history... Comprehensibility Best Practice introduced 2019-05-25 19:55 UTC by Report Bug Copy Issue Report It is recommend to declare an explicit visibility for `__construct`. Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed. If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with `private`, and only raise it to `protected` if a sub-class needs to have access, or `public` if an external class needs access. Loading history...
17		{
18		$this->soteria = new SoteriaService();
19		$this->setOptions();
20		}
21
22	4	public function yaml_loaded()
		0 ignored issues – show Coding Style Naming introduced 2019-05-25 20:26 UTC by Report Bug Copy Issue Report The method yaml_loaded is not named in camelCase. This check marks method names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2019-05-25 20:26 UTC by Report Bug Copy Issue Report Method name "AbstractCerberus::yaml_loaded" is not in camel caps format Loading history...
23		{
24	4	return extension_loaded('yaml');
25		}
26
27	4	protected function processWrappers($handler)
28		{
29	4	$options = $this->getOption('Detection');
30
31	4	foreach ($handler->getWrappers() as $wrapper) {
		0 ignored issues – show Coding Style introduced 2019-05-25 19:55 UTC by Report Bug Copy Issue Report Blank line found at start of control structure Loading history...
32
33	4	$wrapper->setOptions($handler->getValue(), $options['Rules']);
34	4	$wrapper->process();
35	4	$this->addResult($wrapper->getScore(), $wrapper->getResult());
36		}
37	4	}
38
39	4	private function getOption($name)
40		{
41	4	if (!$this->hasOption($name)) {
42		return null;
43		}
44
45	4	return $this->options[$name];
46		}
47
48	4	private function hasOption($name)
49		{
50	4	return isset($this->options[$name]);
51		}
52
53	4	protected function addResult($score, $result)
54		{
55	4	if (is_array($result)) {
56	1	$this->addScore($score);
57	1	$this->result = array_merge($this->result, $result);
58		}
59	4	return $this;
60		}
61
62		/**
63		* @param $score
64		* @return $this
65		*/
66	1	private function addScore($score)
67		{
68	1	$this->score += $score;
69	1	return $this;
70		}
71
72	4	protected function clearResults()
73		{
74	4	$this->results = [];
75	4	$this->result = [];
76	4	$this->score = 0;
77	4	}
78
79		/**
80		* @return array
81		*/
82		protected function getOptions()
83		{
84		return $this->options;
85		}
86
87		/**
88		* @param file\|array $options
89		* @return $this
90		*/
91	4	public function setOptions($options = [])
		0 ignored issues – show Coding Style Naming introduced 2019-05-25 20:26 UTC by Report Bug Copy Issue Report The variable $basic_options is not named in camelCase. This check marks variable names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
92		{
93	4	$basic_options = [];
94	4	if ($this->yaml_loaded()) {
95		$basic_options = yaml_parse_file(__DIR__ . '/Options.yml');
96		}
97	4	if (is_array($options)) {
98	4	$options = $this->arrayMergeRecursiveDistinct($basic_options, $options);
99		} else {
		0 ignored issues – show Coding Style introduced 2019-05-25 19:55 UTC by Report Bug Copy Issue Report The method setOptions uses an else expression. Else is never necessary and you can simplify the code to work without else. Loading history... Coding Style introduced 2019-05-25 19:55 UTC by Report Bug Copy Issue Report Blank line found at start of control structure Loading history...
100
101		$this->soteria->sanitise()->disinfect($options, 'url');
102		if ($this->soteria->sanitise()->result()->isValid()) {
103		$options = $this->arrayMergeRecursiveDistinct($basic_options, yaml_parse_file($options));
104		} else {
		0 ignored issues – show Coding Style introduced 2019-05-25 19:55 UTC by Report Bug Copy Issue Report The method setOptions uses an else expression. Else is never necessary and you can simplify the code to work without else. Loading history...
105		if (file_exists($options)) {
106		$options = $this->arrayMergeRecursiveDistinct($basic_options, yaml_parse_file($options));
107		}
108		}
109		}
110	4	$this->options = $options;
		0 ignored issues – show Documentation Bug introduced 2019-05-25 19:55 UTC by Report Bug Copy Issue Report It seems like `$options` can also be of type `object<devtoolboxuk\cerberus\file>`. However, the property `$options` is declared as type `array`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
111	4	}
112
113	4	private function arrayMergeRecursiveDistinct($merged = [], $array2 = [])
		0 ignored issues – show Complexity introduced 2019-05-25 19:55 UTC by Report Bug Copy Issue Report This operation has 10 execution paths which exceeds the configured maximum of 10. A high number of execution paths generally suggests many nested conditional statements and make the code less readible. This can usually be fixed by splitting the method into several smaller methods. You can also find more information in the “Code” section of your repository. Loading history...
114		{
115	4	if (empty($array2)) {
116		return $merged;
117		}
118
119	4	foreach ($array2 as $key => &$value) {
120	4	if (is_array($value) && isset($merged[$key]) && is_array($merged[$key])) {
121		$merged[$key] = $this->arrayMergeRecursiveDistinct($merged[$key], $value);
122		} else {
		0 ignored issues – show Coding Style introduced 2019-05-25 19:55 UTC by Report Bug Copy Issue Report The method arrayMergeRecursiveDistinct uses an else expression. Else is never necessary and you can simplify the code to work without else. Loading history...
123	4	$merged[$key] = $value;
124		}
125		}
126	4	return $merged;
127		}
128		}

devtoolboxuk / cerberus

Push — master ( 2d3e3c...0995af )

AbstractCerberus::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like