Interface_::doCreate() - Code Metrics - Inspection of "Merge pull request #110 from jaapio/feature/return..." - phpDocumentor/Reflection - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 66de6a...7afc9d )

by Jaap

created 2017-10-10 11:54 UTC

Interface_::doCreate() C

↳ Parent: Interface_

Complexity

Conditions	7
Paths	4

Size

Total Lines	30
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	17
CRAP Score	7.0084

Importance

Changes

Metric	Value
cc	7
eloc	20
nc	4
nop	3
dl	0
loc	30
ccs	17
cts	18
cp	0.9444
crap	7.0084
rs	6.7272
c	0
b	0
f	0

<?php
/**
 * This file is part of phpDocumentor.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @copyright 2010-2015 Mike van Riel<[email protected]>
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */


namespace phpDocumentor\Reflection\Php\Factory;

use InvalidArgumentException;
use phpDocumentor\Reflection\Element;
use phpDocumentor\Reflection\Fqsen;
use phpDocumentor\Reflection\Location;
use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
use phpDocumentor\Reflection\Php\StrategyContainer;
use phpDocumentor\Reflection\Types\Context;
use PhpParser\Comment\Doc;
use PhpParser\Node;
use PhpParser\Node\Stmt\ClassConst;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Interface_ as InterfaceNode;
use phpDocumentor\Reflection\Php\Interface_ as InterfaceElement;

/**
 * Strategy to create a InterfaceElement including all sub elements.
 */
// @codingStandardsIgnoreStart
final class Interface_ extends AbstractFactory implements ProjectFactoryStrategy
// @codingStandardsIgnoreEnd
{

    /**
     * Returns true when the strategy is able to handle the object.
     *
     * @param InterfaceNode $object object to check.
     * @return boolean
     */
    public function matches($object)
    {
        return $object instanceof InterfaceNode;
    }

    /**
     * Creates an Interface_ out of the given object.
     * Since an object might contain other objects that need to be converted the $factory is passed so it can be
     * used to create nested Elements.
     *
     * @param InterfaceNode $object object to convert to an Element
     * @param StrategyContainer $strategies used to convert nested objects.
     * @param Context $context of the created object
     * @return InterfaceElement
     */
    protected function doCreate($object, StrategyContainer $strategies, Context $context = null)
    {
        $docBlock = $this->createDocBlock($strategies, $object->getDocComment(), $context);
        $parents = array();
        foreach ($object->extends as $extend) {
            $parents['\\' . (string)$extend] = new Fqsen('\\' . (string)$extend);
        }

        $interface = new InterfaceElement($object->fqsen, $parents, $docBlock, new Location($object->getLine()));
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        if (isset($object->stmts)) {
            foreach ($object->stmts as $stmt) {
                switch (get_class($stmt)) {
                    case ClassMethod::class:
                        $method = $this->createMember($stmt, $strategies, $context);
                        $interface->addMethod($method);

                        break;
                    case ClassConst::class:
                        $constants = new ClassConstantIterator($stmt);

                        foreach ($constants as $const) {
                            $element = $this->createMember($const, $strategies, $context);
                            $interface->addConstant($element);

                        }
                        break;
                }
            }
        }

        return $interface;
    }
}


1		<?php
2		/**
3		* This file is part of phpDocumentor.
4		*
5		* For the full copyright and license information, please view the LICENSE
6		* file that was distributed with this source code.
7		*
8		* @copyright 2010-2015 Mike van Riel<[email protected]>
9		* @license http://www.opensource.org/licenses/mit-license.php MIT
10		* @link http://phpdoc.org
11		*/
12
13
14		namespace phpDocumentor\Reflection\Php\Factory;
15
16		use InvalidArgumentException;
17		use phpDocumentor\Reflection\Element;
18		use phpDocumentor\Reflection\Fqsen;
19		use phpDocumentor\Reflection\Location;
20		use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
21		use phpDocumentor\Reflection\Php\StrategyContainer;
22		use phpDocumentor\Reflection\Types\Context;
23		use PhpParser\Comment\Doc;
24		use PhpParser\Node;
25		use PhpParser\Node\Stmt\ClassConst;
26		use PhpParser\Node\Stmt\ClassMethod;
27		use PhpParser\Node\Stmt\Interface_ as InterfaceNode;
28		use phpDocumentor\Reflection\Php\Interface_ as InterfaceElement;
29
30		/**
31		* Strategy to create a InterfaceElement including all sub elements.
32		*/
33		// @codingStandardsIgnoreStart
34		final class Interface_ extends AbstractFactory implements ProjectFactoryStrategy
35		// @codingStandardsIgnoreEnd
36		{
37
38		/**
39		* Returns true when the strategy is able to handle the object.
40		*
41		* @param InterfaceNode $object object to check.
42		* @return boolean
43		*/
44	1	public function matches($object)
45		{
46	1	return $object instanceof InterfaceNode;
47		}
48
49		/**
50		* Creates an Interface_ out of the given object.
51		* Since an object might contain other objects that need to be converted the $factory is passed so it can be
52		* used to create nested Elements.
53		*
54		* @param InterfaceNode $object object to convert to an Element
55		* @param StrategyContainer $strategies used to convert nested objects.
56		* @param Context $context of the created object
57		* @return InterfaceElement
58		*/
59	4	protected function doCreate($object, StrategyContainer $strategies, Context $context = null)
60		{
61	4	$docBlock = $this->createDocBlock($strategies, $object->getDocComment(), $context);
62	4	$parents = array();
63	4	foreach ($object->extends as $extend) {
64		$parents['\\' . (string)$extend] = new Fqsen('\\' . (string)$extend);
65		}
66
67	4	$interface = new InterfaceElement($object->fqsen, $parents, $docBlock, new Location($object->getLine()));
		0 ignored issues – show Bug introduced 2017-09-07 19:20 UTC by Report Bug Copy Issue Report It seems like `$docBlock` defined by `$this->createDocBlock($s...DocComment(), $context)` on line `61` can also be of type `object<phpDocumentor\Reflection\Element>`; however, `phpDocumentor\Reflection...terface_::__construct()` does only seem to accept `null\|object<phpDocumentor\Reflection\DocBlock>`, 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...
68
69	4	if (isset($object->stmts)) {
70	2	foreach ($object->stmts as $stmt) {
71	2	switch (get_class($stmt)) {
72		case ClassMethod::class:
73	1	$method = $this->createMember($stmt, $strategies, $context);
74	1	$interface->addMethod($method);
		0 ignored issues – show Compatibility introduced 2015-11-23 21:15 UTC by Report Bug Copy Issue Report `$method` of type `object<phpDocumentor\Reflection\Element>` is not a sub-type of `object<phpDocumentor\Reflection\Php\Method>`. It seems like you assume a concrete implementation of the interface `phpDocumentor\Reflection\Element` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
75	1	break;
76		case ClassConst::class:
77	1	$constants = new ClassConstantIterator($stmt);
		0 ignored issues – show Compatibility introduced 2015-11-23 21:15 UTC by Report Bug Copy Issue Report `$stmt` of type `object<PhpParser\Node>` is not a sub-type of `object<PhpParser\Node\Stmt\ClassConst>`. It seems like you assume a concrete implementation of the interface `PhpParser\Node` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
78	1	foreach ($constants as $const) {
79	1	$element = $this->createMember($const, $strategies, $context);
80	1	$interface->addConstant($element);
		0 ignored issues – show Compatibility introduced 2015-11-23 21:15 UTC by Report Bug Copy Issue Report `$element` of type `object<phpDocumentor\Reflection\Element>` is not a sub-type of `object<phpDocumentor\Reflection\Php\Constant>`. It seems like you assume a concrete implementation of the interface `phpDocumentor\Reflection\Element` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
81		}
82	2	break;
83		}
84		}
85		}
86
87	4	return $interface;
88		}
89		}
90

phpDocumentor / Reflection

Push — develop ( 66de6a...7afc9d )

Interface_::doCreate() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like