phpDocumentor\Reflection\Php\Factory\Property

Complexity

Total Complexity

7

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes	7
Bugs	0	Features	4

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	matches()	0	4	1
A	doCreate()	0	11	2
A	buildVisibility()	0	10	3

<?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\Php\Factory;
use phpDocumentor\Reflection\Php\Property as PropertyDescriptor;
use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
use phpDocumentor\Reflection\Php\StrategyContainer;
use phpDocumentor\Reflection\Php\Visibility;
use phpDocumentor\Reflection\PrettyPrinter;
use phpDocumentor\Reflection\Types\Context;
use PhpParser\Comment\Doc;

/**
 * Strategy to convert PropertyIterator to PropertyDescriptor
 *
 * @see PropertyDescriptor
 * @see PropertyIterator
 */
final class Property 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 PropertyIterator;
    }

    /**
     * Creates an PropertyDescriptor 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 PropertyIterator $object object to convert to an PropertyDescriptor
     * @param StrategyContainer $strategies used to convert nested objects.
     * @param Context $context
     * @return PropertyDescriptor
     */
    protected function doCreate($object, StrategyContainer $strategies, Context $context = null)
    {
        $visibility = $this->buildVisibility($object);
        $default = null;
        if ($object->getDefault() !== null) {
            $default = $this->valueConverter->prettyPrintExpr($object->getDefault());
        }
        $docBlock = $this->createDocBlock($strategies, $object->getDocComment(), $context);

        return new PropertyDescriptor($object->getFqsen(), $visibility, $docBlock, $default, $object->isStatic());

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

    }

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

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