Method::doCreate() - Code Metrics - Inspection of "[WIP] Moved generic parts to an abstract factory" - phpDocumentor/Reflection - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#91)

by Mike

created 2016-01-05 20:35 UTC

Method::doCreate() A

↳ Parent: Method

Complexity

Conditions	2
Paths	2

Size

Total Lines	19
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	19
rs	9.4286
ccs	14
cts	14
cp	1
nc	2
cc	2
eloc	12
nop	3
crap	2

<?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\Php\Method as MethodDescriptor;
use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
use phpDocumentor\Reflection\Php\StrategyContainer;
use phpDocumentor\Reflection\Php\Visibility;
use phpDocumentor\Reflection\Types\Context;
use PhpParser\Comment\Doc;
use PhpParser\Node\Stmt\ClassMethod;

/**
 * Strategy to create MethodDescriptor and arguments when applicable.
 */
final class Method extends AbstractFactory implements ProjectFactoryStrategy
{
    /**
     * Returns true when the strategy is able to handle the object.
     *
     * @param object $object object to check.
     * @return boolean
     */
    public function matches($object)
    {
        return $object instanceof ClassMethod;
    }

    /**
     * Creates an MethodDescriptor out of the given object including its child elements.
     *
     * @param object $object object to convert to an MethodDescriptor
     * @param StrategyContainer $strategies used to convert nested objects.
     * @param Context $context of the created object
     * @return MethodDescriptor
     */
    public function doCreate($object, StrategyContainer $strategies, Context $context = null)
    {
        $docBlock = $this->createDocBlock($object->getDocComment(), $strategies, $context);

        $method = new MethodDescriptor(
            $object->fqsen,
            $this->buildVisibility($object),
            $docBlock,
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $object->isAbstract(),
            $object->isStatic(),
            $object->isFinal()
        );

        foreach ($object->params as $param) {
            $method->addArgument($this->createMember($param, $strategies, $context));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $method;
    }

    /**
     * Converts the visibility of the method to a valid Visibility object.
     *
     * @param ClassMethod $node
     * @return Visibility
     */
    private function buildVisibility(ClassMethod $node)
    {
        if ($node->isPrivate()) {
            return new Visibility(Visibility::PRIVATE_);
        } elseif ($node->isProtected()) {
            return new Visibility(Visibility::PROTECTED_);
        }

        return new Visibility(Visibility::PUBLIC_);
    }
}


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		namespace phpDocumentor\Reflection\Php\Factory;
14
15		use InvalidArgumentException;
16		use phpDocumentor\Reflection\Php\Method as MethodDescriptor;
17		use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
18		use phpDocumentor\Reflection\Php\StrategyContainer;
19		use phpDocumentor\Reflection\Php\Visibility;
20		use phpDocumentor\Reflection\Types\Context;
21		use PhpParser\Comment\Doc;
22		use PhpParser\Node\Stmt\ClassMethod;
23
24		/**
25		* Strategy to create MethodDescriptor and arguments when applicable.
26		*/
27		final class Method extends AbstractFactory implements ProjectFactoryStrategy
28		{
29		/**
30		* Returns true when the strategy is able to handle the object.
31		*
32		* @param object $object object to check.
33		* @return boolean
34		*/
35		public function matches($object)
36	1	{
37		return $object instanceof ClassMethod;
38	1	}
39
40		/**
41		* Creates an MethodDescriptor out of the given object including its child elements.
42		*
43		* @param object $object object to convert to an MethodDescriptor
44		* @param StrategyContainer $strategies used to convert nested objects.
45		* @param Context $context of the created object
46		* @return MethodDescriptor
47		*/
48		public function doCreate($object, StrategyContainer $strategies, Context $context = null)
49	4	{
50		$docBlock = $this->createDocBlock($object->getDocComment(), $strategies, $context);
51	4
52	1	$method = new MethodDescriptor(
53	1	$object->fqsen,
54	1	$this->buildVisibility($object),
55	1	$docBlock,
		0 ignored issues – show Bug introduced 2016-01-05 20:45 UTC by Report Bug Copy Issue Report It seems like `$docBlock` defined by `$this->createDocBlock($o... $strategies, $context)` on line `50` can also be of type `object<phpDocumentor\Reflection\Element>`; however, `phpDocumentor\Reflection\Php\Method::__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...
56	1	$object->isAbstract(),
57	1	$object->isStatic(),
58		$object->isFinal()
59		);
60	3
61		foreach ($object->params as $param) {
62	3	$method->addArgument($this->createMember($param, $strategies, $context));
		0 ignored issues – show Documentation introduced 2016-01-05 20:45 UTC by Report Bug Copy Issue Report `$this->createMember($par... $strategies, $context)` is of type `object<phpDocumentor\Reflection\Element>`, but the function expects a `object<phpDocumentor\Reflection\Php\Argument>`. 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...
63	3	}
64	3
65	3	return $method;
66	3	}
67	3
68	3	/**
69	3	* Converts the visibility of the method to a valid Visibility object.
70		*
71	3	* @param ClassMethod $node
72	1	* @return Visibility
73	1	*/
74	3	private function buildVisibility(ClassMethod $node)
75		{
76	3	if ($node->isPrivate()) {
77		return new Visibility(Visibility::PRIVATE_);
78		} elseif ($node->isProtected()) {
79		return new Visibility(Visibility::PROTECTED_);
80		}
81
82		return new Visibility(Visibility::PUBLIC_);
83		}
84		}
85

phpDocumentor / Reflection

Pull Request — develop (#91)

Method::doCreate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like