Spaark\CompositeUtils\Factory\Reflection\ReflectionMethodFactory

Complexity

Total Complexity

16

Size/Duplication

Total Lines	184
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

83.82%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	fromName()	0	7	1
A	__construct()	0	6	1
A	initParams()	0	13	1
B	addParamAnnotation()	0	31	3
A	addParameter()	0	20	2
C	build()	0	44	8

<?php
/**
 * This file is part of the Composite Utils package.
 *
 * (c) Emily Shepherd <emily@emilyshepherd.me>
 *
 * For the full copyright and license information, please view the
 * LICENSE.md file that was distributed with this source code.
 *
 * @package spaark/composite-utils
 * @author Emily Shepherd <emily@emilyshepherd.me>
 * @license MIT
 */

namespace Spaark\CompositeUtils\Factory\Reflection;

use Spaark\CompositeUtils\Model\Reflection\ReflectionComposite;
use Spaark\CompositeUtils\Model\Reflection\ReflectionMethod;
use Spaark\CompositeUtils\Model\Reflection\ReflectionParameter;
use Spaark\CompositeUtils\Model\Type\ObjectType;
use Spaark\CompositeUtils\Service\RawPropertyAccessor;
use Spaark\CompositeUtils\Service\TypeComparator;
use Spaark\CompositeUtils\Model\Collection\ListCollection\FixedList;
use Spaark\CompositeUtils\Model\Collection\Map\HashMap;
use \ReflectionMethod as PHPNativeReflectionMethod;
use \ReflectionParameter as PHPNativeReflectionParameter;
use \Reflector as PHPNativeReflector;

/**
 * Builds a ReflectionMethod for a given method and optionally links
 * this to a parent ReflectionComposite
 */
class ReflectionMethodFactory extends ReflectorFactory
{
    const REFLECTION_OBJECT = ReflectionMethod::class;

    /**
     * @var PHPNativeReflectionMethod
     */
    protected $reflector;

    /**
     * @var ReflectionMethod
     */
    protected $object;

    /**
     * @var Hashmap
     */
    protected $parameters;

    /**
     * @var TypeParser
     */
    protected $typeParser;

    /**
     * Returns a new ReflectionMethodFactory using the given class and
     * method names
     *
     * @param string $class The classname of the method
     * @param string $method The method to reflect
     * @return ReflectionMethodFactory
     */
    public static function fromName(string $class, string $method)
    {
        return new static(new PHPNativeReflectionMethod
        (
            $class, $method
        ));
    }

    public function __construct(PHPNativeReflector $reflector)
    {
        parent::__construct($reflector);

        $this->parameters = new HashMap();

It seems like new \Spaark\CompositeUtils\Model\Collection\Map\HashMap() of type object<Spaark\CompositeUtils\Model\Collection\Map\HashMap> is incompatible with the declared type object<Spaark\CompositeUtils\Factory\Reflection\Hashmap> of property $parameters.

    }

    /**
     * Builds the ReflectionMethod from the provided parameters,
     * optionally linking to a parent ReflectionComposite
     *
     * @param ReflectionComposite $parent The reflector for the class
     *     this method belongs to
     * @return ReflectionMethod
     */
    public function build(?ReflectionComposite $parent = null)
    {
        $this->typeParser = new TypeParser($parent);
        $this->accessor->setRawValue('owner', $parent);
        $this->accessor->setRawValue
        (
            'name',
            $this->reflector->getName()

Consider using $this->reflector->name. There is an issue with getName() and APC-enabled PHP versions.

        );

        $this->initParams();

        $this->accessor->setRawValue('visibility',
              ($this->reflector->isPublic() ? 'public'
            : ($this->reflector->isProtected() ? 'protected'
            : ($this->reflector->isPrivate() ? 'private'
            : (''))))
        );
        $this->accessor->setRawValue('scope',
            ($this->reflector->isStatic() ? 'static' : 'dynamic')
        );
        $this->accessor->setRawValue('final',
            $this->reflector->isFinal()
        );

        foreach ($this->reflector->getParameters() as $parameter)
        {
            $this->addParameter($parameter);
        }

        $type = $this->reflector->getReturnType();
        if ($type)
        {
            $this->accessor->setRawValue
            (
                'nativeReturnType',
                !$type->isBuiltin() ? '\\' . $type : (string)$type
            );
        }

        $this->parseDocComment(['param' => 'addParamAnnotation']);

        return $this->object;
    }

    /**
     * Creates the Method's parameter's property with a fixd list of
     * the appropriate size
     */
    protected function initParams()
    {
        $this->accessor->setRawValue
        (
            'parameters',
            new FixedList(count($this->reflector->getParameters()))
        );
        $this->accessor->setRawValue
        (
            'nativeParameters',
            new FixedList(count($this->reflector->getParameters()))
        );
    }

    /**
     * Processes a param docblock annotation and uses it to decorate
     * a method parameter
     *
     * @param string $name Unused. Should be 'param'
     * @param string $value The annotation value
     */
    protected function addParamAnnotation($name, $value) : void

The parameter $name is not used and could be removed.

    {
        $items = explode(' ', $value);
        $type = $items[0];
        $param = $items[1];

        if (!$this->parameters->containsKey($param))
        {
            throw new \Exception
            (
                  'Tried to set param annotation for non existant '
                . 'parameter: ' . $param
            );
        }

        $comparator = new TypeComparator();
        $type = $this->typeParser->parse($type);
        $param = $this->parameters[$param];
        $nativeType = $param->getRawValue('type');

        if (!$comparator->compatible($nativeType, $type))
        {
            throw new \Exception
            (
                  'Types are incompatible for: '
                . $this->reflector->getName() . '::' . $items[1]

Consider using $this->reflector->name. There is an issue with getName() and APC-enabled PHP versions.

            );
        }

        $param->setRawValue('type', $type);
    }

    /**
     * Adds a parameter to the method, based on it's native
     * ReflectionParameter
     *
     * @param PHPNativeReflectionParameter $reflect
     */
    protected function addParameter
    (
        PHPNativeReflectionParameter $reflect
    )
    : void
    {
        $parameter = new ReflectionParameter();
        $accessor = new RawPropertyAccessor($parameter);
        $type = (new TypeParser())->parse((string)$reflect->getType());

        $this->parameters['$' . $reflect->getName()] = $accessor;

Consider using $reflect->name. There is an issue with getName() and APC-enabled PHP versions.

        $this->accessor->rawAddToValue('parameters', $parameter);

The method Spaark\CompositeUtils\Service\RawPropertyAccessor::rawAddToValue() has been deprecated.

        $this->accessor->rawAddToValue('nativeParameters',

The method Spaark\CompositeUtils\Service\RawPropertyAccessor::rawAddToValue() has been deprecated.

            ($type instanceOf ObjectType ? '\\' : '') . (string)$type

The class Spaark\CompositeUtils\Model\Type\ObjectType does not exist. Did you forget a USE statement, or did you not list all dependencies?

        );

        $accessor->setRawValue('owner', $this->object);
        $accessor->setRawValue('name', $reflect->getName());

Consider using $reflect->name. There is an issue with getName() and APC-enabled PHP versions.

        $accessor->setRawValue('type', $type);
    }
}