Interface_::matches() - Code Metrics - Inspection of "Moved generic parts to an abstract factory" - phpDocumentor/Reflection - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#91)

by Jaap

created 2016-01-11 09:36 UTC

Interface_::matches() A

↳ Parent: Interface_

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

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

<?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\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);
/**
 * @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\Php\ProjectFactoryStrategy;
20		use phpDocumentor\Reflection\Php\StrategyContainer;
21		use phpDocumentor\Reflection\Types\Context;
22		use PhpParser\Comment\Doc;
23		use PhpParser\Node;
24		use PhpParser\Node\Stmt\ClassConst;
25		use PhpParser\Node\Stmt\ClassMethod;
26		use PhpParser\Node\Stmt\Interface_ as InterfaceNode;
27		use phpDocumentor\Reflection\Php\Interface_ as InterfaceElement;
28
29		/**
30		* Strategy to create a InterfaceElement including all sub elements.
31		*/
32		// @codingStandardsIgnoreStart
33		final class Interface_ extends AbstractFactory implements ProjectFactoryStrategy
34		// @codingStandardsIgnoreEnd
35		{
36
37		/**
38		* Returns true when the strategy is able to handle the object.
39		*
40		* @param InterfaceNode $object object to check.
41		* @return boolean
42		*/
43	1	public function matches($object)
44		{
45	1	return $object instanceof InterfaceNode;
46		}
47
48		/**
49		* Creates an Interface_ out of the given object.
50		* Since an object might contain other objects that need to be converted the $factory is passed so it can be
51		* used to create nested Elements.
52		*
53		* @param InterfaceNode $object object to convert to an Element
54		* @param StrategyContainer $strategies used to convert nested objects.
55		* @param Context $context of the created object
56		* @return InterfaceElement
57		*/
58	4	protected function doCreate($object, StrategyContainer $strategies, Context $context = null)
59		{
60	4	$docBlock = $this->createDocBlock($strategies, $object->getDocComment(), $context);
61	4	$parents = array();
62	4	foreach ($object->extends as $extend) {
63		$parents['\\' . (string)$extend] = new Fqsen('\\' . (string)$extend);
64	4	}
65
66	4	$interface = new InterfaceElement($object->fqsen, $parents, $docBlock);
		0 ignored issues – show Bug introduced 2015-11-23 21:15 UTC by Report Bug Copy Issue Report The property `fqsen` does not seem to exist in `PhpParser\Node\Stmt\Interface_`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history... Bug introduced 2016-01-10 22:22 UTC by Report Bug Copy Issue Report It seems like `$docBlock` defined by `$this->createDocBlock($s...DocComment(), $context)` on line `60` 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...
67
68	4	if (isset($object->stmts)) {
69	2	foreach ($object->stmts as $stmt) {
70	2	switch (get_class($stmt)) {
71	2	case ClassMethod::class:
72	1	$method = $this->createMember($stmt, $strategies, $context);
73	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...
74	1	break;
75	1	case ClassConst::class:
76	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...
77	1	foreach ($constants as $const) {
78	1	$element = $this->createMember($const, $strategies, $context);
79	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...
80	1	}
81	1	break;
82	2	}
83	2	}
84	2	}
85
86	4	return $interface;
87		}
88		}
89

phpDocumentor / Reflection

Pull Request — develop (#91)

Interface_::matches() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like