Constant::__construct() - 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 Jaap

created 2016-01-07 20:21 UTC

Constant::__construct() A

↳ Parent: Constant

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	4
c	1
b	0
f	0
ccs	0
cts	3
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	1
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 phpDocumentor\Reflection\Php\Constant as ConstantElement;
use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
use phpDocumentor\Reflection\Php\StrategyContainer;
use phpDocumentor\Reflection\PrettyPrinter;
use phpDocumentor\Reflection\Types\Context;
use PhpParser\Comment\Doc;

/**
 * Strategy to convert ClassConstantIterator to ConstantElement
 *
 * @see ConstantElement
 * @see ClassConstantIterator
 */
final class Constant extends AbstractFactory implements ProjectFactoryStrategy
{
    /**
     * @var PrettyPrinter
     */
    private $valueConverter;

    /**
     * Initializes the object.
     *
     * @param PrettyPrinter $prettyPrinter
     */
    public function __construct(PrettyPrinter $prettyPrinter)
    {
        $this->valueConverter = $prettyPrinter;
    }

    /**
     * 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 ClassConstantIterator;
    }

    /**
     * Creates an Constant 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 ClassConstantIterator $object object to convert to an Element
     * @param StrategyContainer $strategies used to convert nested objects.
     * @param Context $context of the created object
     * @return Constant
     */
    protected function doCreate($object, StrategyContainer $strategies, Context $context = null)
    {
        $docBlock = $this->createDocBlock($object->getDocComment(), $strategies, $context);
        $default = null;
        if ($object->getValue() !== null) {
            $default = $this->valueConverter->prettyPrintExpr($object->getValue());
        }

        return new ConstantElement($object->getFqsen(), $docBlock, $default);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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


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 phpDocumentor\Reflection\Php\Constant as ConstantElement;
17			use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
18			use phpDocumentor\Reflection\Php\StrategyContainer;
19			use phpDocumentor\Reflection\PrettyPrinter;
20			use phpDocumentor\Reflection\Types\Context;
21			use PhpParser\Comment\Doc;
22
23			/**
24			* Strategy to convert ClassConstantIterator to ConstantElement
25			*
26			* @see ConstantElement
27			* @see ClassConstantIterator
28			*/
29			final class Constant extends AbstractFactory implements ProjectFactoryStrategy
30			{
31			/**
32			* @var PrettyPrinter
33			*/
34			private $valueConverter;
35
36			/**
37			* Initializes the object.
38			*
39			* @param PrettyPrinter $prettyPrinter
40			*/
41			public function __construct(PrettyPrinter $prettyPrinter)
42			{
43			$this->valueConverter = $prettyPrinter;
44			}
45
46			/**
47			* Returns true when the strategy is able to handle the object.
48			*
49			* @param object $object object to check.
50			* @return boolean
51			*/
52			public function matches($object)
53			{
54			return $object instanceof ClassConstantIterator;
55			}
56
57			/**
58			* Creates an Constant out of the given object.
59			* Since an object might contain other objects that need to be converted the $factory is passed so it can be
60			* used to create nested Elements.
61			*
62			* @param ClassConstantIterator $object object to convert to an Element
63			* @param StrategyContainer $strategies used to convert nested objects.
64			* @param Context $context of the created object
65			* @return Constant
66			*/
67			protected function doCreate($object, StrategyContainer $strategies, Context $context = null)
68			{
69			$docBlock = $this->createDocBlock($object->getDocComment(), $strategies, $context);
70			$default = null;
71			if ($object->getValue() !== null) {
72			$default = $this->valueConverter->prettyPrintExpr($object->getValue());
73			}
74
75			return new ConstantElement($object->getFqsen(), $docBlock, $default);
			0 ignored issues – show Bug introduced 2015-11-23 21:15 UTC by Report Bug Copy Issue Report It seems like `$docBlock` defined by `$this->createDocBlock($o... $strategies, $context)` on line `69` can also be of type `object<phpDocumentor\Reflection\Element>`; however, `phpDocumentor\Reflection...Constant::__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...
76			}
77			}
78

phpDocumentor / Reflection

Pull Request — develop (#91)

Constant::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like