ParameterMetadata::__construct() - Code Metrics - Inspection of "Almost done, minor things to do, test to write..." - RunOpenCode/abstract-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( edf0e8...eb9261 )

by Nikola

created 2017-07-01 21:36 UTC

ParameterMetadata::__construct() A

↳ Parent: ParameterMetadata

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
/*
 * This file is part of the Abstract builder package, an RunOpenCode project.
 *
 * (c) 2017 RunOpenCode
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace RunOpenCode\AbstractBuilder\Ast\Metadata;

use PhpParser\Node\Param;

/**
 * Class ParameterMetadata
 *
 * @package RunOpenCode\AbstractBuilder\Ast\Metadata
 */
class ParameterMetadata
{
    /**
     * @var string
     */
    private $name;

    /**
     * @var string
     */
    private $type;

    /**
     * @var bool
     */
    private $byRef;

    /**
     * @var bool
     */
    private $variadic;

    /**
     * @var mixed
     */
    private $default;

    /**
     * @var Param
     */
    private $ast;

    /**
     * ParameterMetadata constructor.
     *
     * @param string $name
     * @param string $type
     * @param bool $byRef
     * @param bool $variadic
     * @param mixed $default
     */
    public function __construct($name, $type = null, $byRef = false, $variadic = false, $default = null, Param $ast = null)
    {
        $this->name = $name;
        $this->type = $type;
        $this->byRef = $byRef;
        $this->variadic = $variadic;
        $this->default = $default;
        $this->ast = $ast;
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @return bool
     */
    public function byReference()
    {
        return $this->byRef;
    }

    /**
     * @return bool
     */
    public function isVariadic()
    {
        return $this->variadic;
    }

    /**
     * @return mixed
     */
    public function getDefault()
    {
        return $this->default;
    }

    /**
     * @return Param
     */
    public function getAst()
    {
        return $this->ast;
    }

    /**
     * Creates parameter metadata instance from \PhpParser\Node\Param
     *
     * @param Param $param
     * @return ParameterMetadata|static
     */
    public static function fromParameter(Param $param)
    {
        return new static(
            $param->name,
            $param->type,
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $param->byRef,
            $param->variadic,
            $param->default,
            $param
        );
    }
}


1			<?php
2			/*
3			* This file is part of the Abstract builder package, an RunOpenCode project.
4			*
5			* (c) 2017 RunOpenCode
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10			namespace RunOpenCode\AbstractBuilder\Ast\Metadata;
11
12			use PhpParser\Node\Param;
13
14			/**
15			* Class ParameterMetadata
16			*
17			* @package RunOpenCode\AbstractBuilder\Ast\Metadata
18			*/
19			class ParameterMetadata
20			{
21			/**
22			* @var string
23			*/
24			private $name;
25
26			/**
27			* @var string
28			*/
29			private $type;
30
31			/**
32			* @var bool
33			*/
34			private $byRef;
35
36			/**
37			* @var bool
38			*/
39			private $variadic;
40
41			/**
42			* @var mixed
43			*/
44			private $default;
45
46			/**
47			* @var Param
48			*/
49			private $ast;
50
51			/**
52			* ParameterMetadata constructor.
53			*
54			* @param string $name
55			* @param string $type
56			* @param bool $byRef
57			* @param bool $variadic
58			* @param mixed $default
59			*/
60			public function __construct($name, $type = null, $byRef = false, $variadic = false, $default = null, Param $ast = null)
61			{
62			$this->name = $name;
63			$this->type = $type;
64			$this->byRef = $byRef;
65			$this->variadic = $variadic;
66			$this->default = $default;
67			$this->ast = $ast;
68			}
69
70			/**
71			* @return string
72			*/
73			public function getName()
74			{
75			return $this->name;
76			}
77
78			/**
79			* @return string
80			*/
81			public function getType()
82			{
83			return $this->type;
84			}
85
86			/**
87			* @return bool
88			*/
89			public function byReference()
90			{
91			return $this->byRef;
92			}
93
94			/**
95			* @return bool
96			*/
97			public function isVariadic()
98			{
99			return $this->variadic;
100			}
101
102			/**
103			* @return mixed
104			*/
105			public function getDefault()
106			{
107			return $this->default;
108			}
109
110			/**
111			* @return Param
112			*/
113			public function getAst()
114			{
115			return $this->ast;
116			}
117
118			/**
119			* Creates parameter metadata instance from \PhpParser\Node\Param
120			*
121			* @param Param $param
122			* @return ParameterMetadata\|static
123			*/
124			public static function fromParameter(Param $param)
125			{
126			return new static(
127			$param->name,
128			$param->type,
			0 ignored issues – show Bug introduced 2017-06-27 20:06 UTC by Report Bug Copy Issue Report It seems like `$param->type` can also be of type `object<PhpParser\Node\Name>` or `object<PhpParser\Node\NullableType>`; however, `RunOpenCode\AbstractBuil...Metadata::__construct()` does only seem to accept `string\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
129			$param->byRef,
130			$param->variadic,
131			$param->default,
132			$param
133			);
134			}
135			}
136

RunOpenCode / abstract-builder

Push — master ( edf0e8...eb9261 )

ParameterMetadata::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like