PhpParameter::fromReflection() - Code Metrics - Inspection of "fix travis" - gossi/php-code-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c0dc80...73a4ac )

by Thomas

created 2016-11-15 12:55 UTC

PhpParameter::fromReflection() C

↳ Parent: PhpParameter

Complexity

Conditions	14
Paths	30

Size

Total Lines	44
Code Lines	28

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	24
CRAP Score	14.5719

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	44
ccs	24
cts	28
cp	0.8571
rs	5.0864
cc	14
eloc	28
nc	30
nop	1
crap	14.5719

How to fix Complexity

<?php
/*
 * Copyright 2011 Johannes M. Schmitt <[email protected]>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace gossi\codegen\model;

use gossi\codegen\model\parts\NamePart;
use gossi\codegen\model\parts\TypePart;
use gossi\codegen\model\parts\ValuePart;
use gossi\docblock\Docblock;
use gossi\docblock\tags\ParamTag;

/**
 * Represents a PHP parameter.
 *
 * @author Johannes M. Schmitt <[email protected]>
 * @author Thomas Gossmann
 */
class PhpParameter extends AbstractModel implements ValueInterface {

	use NamePart;
	use TypePart;
	use ValuePart;

	private $passedByReference = false;

	/**
	 * Creates a new PHP parameter.
	 *
	 * @param string $name the parameter name
	 * @return static
	 */
	public static function create($name = null) {
		return new static($name);
	}

	/**
	 * Creates a PHP parameter from reflection
	 *
	 * @deprecated will be removed in version 0.5
	 * @param \ReflectionParameter $ref
	 * @return PhpParameter
	 */
	public static function fromReflection(\ReflectionParameter $ref) {
		$parameter = new static();
		$parameter->setName($ref->name)->setPassedByReference($ref->isPassedByReference());

		if ($ref->isDefaultValueAvailable()) {
			$value = $ref->getDefaultValue();
			
			if (is_string($value)
					|| is_int($value)
					|| is_float($value)
					|| is_bool($value)
					|| is_null($value)
					|| ($value instanceof PhpConstant)) {
				$parameter->setValue($value);
			} else {
				$parameter->setExpression($value);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			}
		}

		// find type and description in docblock
		$docblock = new Docblock($ref->getDeclaringFunction());

		$params = $docblock->getTags('param');
		$tag = $params->find($ref->name, function (ParamTag $t, $name) {
			return $t->getVariable() == '$' . $name;
		});

		if ($tag !== null) {
			$parameter->setType($tag->getType(), $tag->getDescription());
		}

		// set type if not found in comment
		if ($parameter->getType() === null) {
			if ($ref->isArray()) {
				$parameter->setType('array');
			} elseif ($class = $ref->getClass()) {
				$parameter->setType($class->getName());
			} elseif (method_exists($ref, 'isCallable') && $ref->isCallable()) {
				$parameter->setType('callable');
			}
		}

		return $parameter;
	}

	/**
	 * Creates a new PHP parameter
	 *
	 * @param string $name the parameter name
	 */
	public function __construct($name = null) {
		$this->setName($name);
	}

	/**
	 * Sets whether this parameter is passed by reference
	 *
	 * @param bool $bool `true` if passed by reference and `false` if not
	 * @return $this
	 */
	public function setPassedByReference($bool) {
		$this->passedByReference = (boolean) $bool;

		return $this;
	}

	/**
	 * Returns whether this parameter is passed by reference
	 *
	 * @return bool `true` if passed by reference and `false` if not
	 */
	public function isPassedByReference() {
		return $this->passedByReference;
	}

	/**
	 * Returns a docblock tag for this parameter
	 *
	 * @return ParamTag
	 */
	public function getDocblockTag() {
		return ParamTag::create()
			->setType($this->getType())
			->setVariable($this->getName())
			->setDescription($this->getTypeDescription());
	}

	/**
	 * Alias for setDescription()
	 *
	 * @see #setDescription
	 * @param string $description
	 * @return $this
	 */
	public function setTypeDescription($description) {
		return $this->setDescription($description);
	}

	/**
	 * Alias for getDescription()
	 *
	 * @see #getDescription
	 * @return string
	 */
	public function getTypeDescription() {
		return $this->getDescription();
	}
}


1		<?php
2		/*
3		* Copyright 2011 Johannes M. Schmitt <[email protected]>
4		*
5		* Licensed under the Apache License, Version 2.0 (the "License");
6		* you may not use this file except in compliance with the License.
7		* You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17		namespace gossi\codegen\model;
18
19		use gossi\codegen\model\parts\NamePart;
20		use gossi\codegen\model\parts\TypePart;
21		use gossi\codegen\model\parts\ValuePart;
22		use gossi\docblock\Docblock;
23		use gossi\docblock\tags\ParamTag;
24
25		/**
26		* Represents a PHP parameter.
27		*
28		* @author Johannes M. Schmitt <[email protected]>
29		* @author Thomas Gossmann
30		*/
31		class PhpParameter extends AbstractModel implements ValueInterface {
32
33		use NamePart;
34		use TypePart;
35		use ValuePart;
36
37		private $passedByReference = false;
38
39		/**
40		* Creates a new PHP parameter.
41		*
42		* @param string $name the parameter name
43		* @return static
44		*/
45	19	public static function create($name = null) {
46	19	return new static($name);
47		}
48
49		/**
50		* Creates a PHP parameter from reflection
51		*
52		* @deprecated will be removed in version 0.5
53		* @param \ReflectionParameter $ref
54		* @return PhpParameter
55		*/
56	2	public static function fromReflection(\ReflectionParameter $ref) {
57	2	$parameter = new static();
58	2	$parameter->setName($ref->name)->setPassedByReference($ref->isPassedByReference());
59
60	2	if ($ref->isDefaultValueAvailable()) {
61	2	$value = $ref->getDefaultValue();
62
63	2	if (is_string($value)
64	1	\|\| is_int($value)
65	1	\|\| is_float($value)
66	1	\|\| is_bool($value)
67	1	\|\| is_null($value)
68	2	\|\| ($value instanceof PhpConstant)) {
69	2	$parameter->setValue($value);
70		} else {
71		$parameter->setExpression($value);
		1 ignored issue – show Documentation introduced 2016-11-15 12:27 UTC by Report Bug Copy Issue Report `$value` is of type `object\|array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
72		}
73		}
74
75		// find type and description in docblock
76	2	$docblock = new Docblock($ref->getDeclaringFunction());
77
78	2	$params = $docblock->getTags('param');
79	2	$tag = $params->find($ref->name, function (ParamTag $t, $name) {
80	2	return $t->getVariable() == '$' . $name;
81	2	});
82
83	2	if ($tag !== null) {
84	2	$parameter->setType($tag->getType(), $tag->getDescription());
85		}
86
87		// set type if not found in comment
88	2	if ($parameter->getType() === null) {
89	1	if ($ref->isArray()) {
90		$parameter->setType('array');
91	1	} elseif ($class = $ref->getClass()) {
92		$parameter->setType($class->getName());
93	1	} elseif (method_exists($ref, 'isCallable') && $ref->isCallable()) {
94		$parameter->setType('callable');
95		}
96		}
97
98	2	return $parameter;
99		}
100
101		/**
102		* Creates a new PHP parameter
103		*
104		* @param string $name the parameter name
105		*/
106	32	public function __construct($name = null) {
107	32	$this->setName($name);
108	32	}
109
110		/**
111		* Sets whether this parameter is passed by reference
112		*
113		* @param bool $bool `true` if passed by reference and `false` if not
114		* @return $this
115		*/
116	12	public function setPassedByReference($bool) {
117	12	$this->passedByReference = (boolean) $bool;
118
119	12	return $this;
120		}
121
122		/**
123		* Returns whether this parameter is passed by reference
124		*
125		* @return bool `true` if passed by reference and `false` if not
126		*/
127	12	public function isPassedByReference() {
128	12	return $this->passedByReference;
129		}
130
131		/**
132		* Returns a docblock tag for this parameter
133		*
134		* @return ParamTag
135		*/
136	7	public function getDocblockTag() {
137	7	return ParamTag::create()
138	7	->setType($this->getType())
139	7	->setVariable($this->getName())
140	7	->setDescription($this->getTypeDescription());
141		}
142
143		/**
144		* Alias for setDescription()
145		*
146		* @see #setDescription
147		* @param string $description
148		* @return $this
149		*/
150	7	public function setTypeDescription($description) {
151	7	return $this->setDescription($description);
152		}
153
154		/**
155		* Alias for getDescription()
156		*
157		* @see #getDescription
158		* @return string
159		*/
160	9	public function getTypeDescription() {
161	9	return $this->getDescription();
162		}
163		}
164

gossi / php-code-generator

Push — master ( c0dc80...73a4ac )

PhpParameter::fromReflection() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like