phpDocumentor\Reflection\Php\Factory\Class_

Complexity

Total Complexity

19

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

91.84%

Importance

Changes	7
Bugs	1	Features	3

4 Methods

Rating	Name	Duplication	Size	Complexity
A	matches()	0	4	1
A	createMember()	0	5	1
C	create()	0	61	15
A	createDocBlock()	0	8	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<mike@phpdoc.org>
 * @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\Class_ as ClassElement;
use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
use phpDocumentor\Reflection\Php\StrategyContainer;
use phpDocumentor\Reflection\Types\Context;
use PhpParser\Node;
use PhpParser\Node\Stmt\Class_ as ClassNode;
use PhpParser\Node\Stmt\ClassConst;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Property as PropertyNode;
use PhpParser\Comment\Doc;
use PhpParser\Node\Stmt\TraitUse;

/**
 * Strategy to create a ClassElement including all sub elements.
 */
final class Class_ implements ProjectFactoryStrategy

The class Class_ has a coupling between objects value of 16. Consider to reduce the number of dependencies under 13.

This class is not in CamelCase format.

{

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

    /**
     * Creates an ClassElement 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 ClassNode $object object to convert to an Element
     * @param StrategyContainer $strategies used to convert nested objects.
     * @param Context $context of the created object
     * @return ClassElement
     */
    public function create($object, StrategyContainer $strategies, Context $context = null)

This operation has 810 execution paths which exceeds the configured maximum of 200.

    {
        if (!$this->matches($object)) {
            throw new InvalidArgumentException(
                sprintf('%s cannot handle objects with the type %s',
                    __CLASS__,
                    is_object($object) ? get_class($object) : gettype($object)
                )
            );
        }

        $docBlock = $this->createDocBlock($object->getDocComment(), $strategies, $context);

        $classElement = new ClassElement(
            $object->fqsen,

The property fqsen does not seem to exist in PhpParser\Node\Stmt\Class_.

            $docBlock,

It seems like $docBlock defined by $this->createDocBlock($object->getDocComment(), $strategies, $context) on line 69 can also be of type object<phpDocumentor\Reflection\Element>; however, phpDocumentor\Reflection\Php\Class_::__construct() does only seem to accept null|object<phpDocumentor\Reflection\DocBlock>, maybe add an additional type check?

            $object->extends ? new Fqsen('\\' . $object->extends) : null,
            $object->isAbstract(),
            $object->isFinal()
        );

        if (isset($object->implements)) {
            foreach ($object->implements as $interfaceClassName) {
                $classElement->addInterface(
                    new Fqsen('\\' . $interfaceClassName->toString())
                );
            }
        }

        if (isset($object->stmts)) {
            foreach ($object->stmts as $stmt) {
                switch (get_class($stmt)) {
                    case TraitUse::class:
                        foreach ($stmt->traits as $use) {

Accessing traits on the interface PhpParser\Node suggest that you code against a concrete implementation. How about adding an instanceof check?

                            $classElement->addUsedTrait(new Fqsen('\\'. $use->toString()));
                        }
                        break;
                    case PropertyNode::class:
                        $properties = new PropertyIterator($stmt);

$stmt of type object<PhpParser\Node> is not a sub-type of object<PhpParser\Node\Stmt\Property>. It seems like you assume a concrete implementation of the interface PhpParser\Node to be always present.

                        foreach ($properties as $property) {
                            $element = $this->createMember($property, $strategies, $context);
                            $classElement->addProperty($element);

$element of type object<phpDocumentor\Reflection\Element> is not a sub-type of object<phpDocumentor\Reflection\Php\Property>. It seems like you assume a concrete implementation of the interface phpDocumentor\Reflection\Element to be always present.

                        }
                        break;
                    case ClassMethod::class:
                        $method = $this->createMember($stmt, $strategies, $context);
                        $classElement->addMethod($method);

$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.

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

$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.

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

$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.

                        }
                        break;
                }
            }
        }

        return $classElement;
    }

    /**
     * @param Node|PropertyIterator|ClassConstantIterator $stmt
     * @param StrategyContainer $strategies
     * @param Context $context
     * @return Element
     */
    private function createMember($stmt, StrategyContainer $strategies, Context $context = null)
    {
        $strategy = $strategies->findMatching($stmt);
        return $strategy->create($stmt, $strategies, $context);
    }


    /**
     * @param Doc $docBlock
     * @param StrategyContainer $strategies
     * @param Context $context
     * @return null|\phpDocumentor\Reflection\DocBlock
     */
    private function createDocBlock(Doc $docBlock = null, StrategyContainer $strategies, Context $context = null)

Parameters which have default values should be placed at the end.

    {
        if ($docBlock === null) {
            return null;
        }

        return $this->createMember($docBlock, $strategies, $context);

$docBlock is of type object<PhpParser\Comment\Doc>, but the function expects a object<PhpParser\Node>|object<phpDocumentor\Reflection\Php\Factory\PropertyIterator>|object<phpDocumentor\Reflection\Php\Factory\ClassConstantIterator>.

    }
}