Phoole\Di\Util\FactoryTrait

Complexity

Total Complexity

23

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	executeCallable()	0	20	5
A	fabricate()	0	14	2
A	fixMethod()	0	15	5
A	fixDefinition()	0	11	4
A	aroundConstruct()	0	12	3
A	constructObject()	0	17	4

<?php

/**
 * Phoole (PHP7.2+)
 *
 * @category  Library
 * @package   Phoole\Di
 * @copyright Copyright (c) 2019 Hong Zhang
 */
declare(strict_types=1);

namespace Phoole\Di\Util;

use Phoole\Di\Exception\LogicException;
use Phoole\Di\Exception\UnresolvedClassException;

/**
 * FactoryTrait
 *
 * Fabricate object by its definition
 *
 * @package Phoole\Di
 */
trait FactoryTrait
{
    use AutowiringTrait;

    /**
     * fabricate the object using the definition
     *
     * @param  array $definition
     * @return object
     * @throws LogicException   if 'before|after' methods defined wrong
     * @throws UnresolvedClassException if parameter unresolved
     */
    protected function fabricate(array $definition): object
    {
        // execute its own beforehand methods
        $this->aroundConstruct($definition, 'before');

        // construct it
        if (is_string($definition['class'])) { // class name provided
            $obj = $this->constructObject($definition['class'], $definition['args']);
        } else { // callable stored in $def['class']
            $obj = $this->executeCallable($definition['class'], $definition['args']);
        }

        // execute its own aftermath methods
        return $this->aroundConstruct($definition, 'after', $obj);

The expression return $this->aroundConstruct($definition, 'after', $obj) could return the type null which is incompatible with the type-hinted return object. Consider adding an additional type-check to rule them out.

    }

    /**
     * fix object definition
     *
     * @param  mixed $definition
     * @return array
     */
    protected function fixDefinition($definition): array
    {
        if (!is_array($definition) || !isset($definition['class'])) {
            $definition = ['class' => $definition];
        }

        if (!isset($definition['args'])) {
            $definition['args'] = [];
        }

        return (array) $definition;
    }

    /**
     * Instantiate the object
     *
     * @param  string $class      class name
     * @param  array  $arguments  constructor arguments
     * @return object
     * @throws UnresolvedClassException if parameters unresolved
     * @throws LogicException if definition went wrong
     */
    protected function constructObject(string $class, array $arguments): object
    {
        try {
            $reflector = new \ReflectionClass($class);
            $constructor = $reflector->getConstructor();
            if (is_null($constructor)) {
                return $reflector->newInstanceWithoutConstructor();
            } else {
                $arguments = $this->matchArguments(
                    $arguments, $constructor->getParameters()
                );
                return $reflector->newInstanceArgs($arguments);
            }
        } catch (UnresolvedClassException $e) {
            throw $e;
        } catch (\Throwable $e) {
            throw new LogicException($e->getMessage());
        }
    }

    /**
     * execute callable
     *
     * @param  callable|object $callable   callable
     * @param  array           $arguments  constructor arguments
     * @return mixed
     * @throws LogicException       if definition went wrong
     * @throws UnresolvedClassException if parameter unresolved
     */
    protected function executeCallable($callable, array $arguments)
    {
        if (is_callable($callable)) {
            try {
                $arguments = $this->matchArguments(
                    $arguments, $this->getCallableParameters($callable)

It seems like $callable can also be of type object; however, parameter $callable of Phoole\Di\Util\FactoryTrait::getCallableParameters() does only seem to accept callable, maybe add an additional type check?

                );
                return call_user_func_array($callable, $arguments);
            } catch (UnresolvedClassException $e) {
                throw $e;
            } catch (\Throwable $e) {
                throw new LogicException($e->getMessage());
            }
        }

        if (is_object($callable)) {
            return $callable;
        }

        throw new LogicException((string) $callable . " not a callable");
    }

    /**
     * Processing service beforehand / aftermath
     *
     * @param  array  $definition  service definition
     * @param  string $stage       'before' or 'after'
     * @param  object $object      the created object
     * @return object|null
     * @throws UnresolvedClassException if arguments not resolved
     * @throws LogicException if method definitions went wrong
     */
    protected function aroundConstruct(
        array $definition, string $stage, ?object $object = NULL
    ): ?object {
        if (isset($definition[$stage])) {
            foreach ($definition[$stage] as $line) {
                list($callable, $arguments) = $this->fixMethod(
                    (array) $line, $object ?? $definition
                );
                $this->executeCallable($callable, $arguments);
            }
        }
        return $object;
    }

    /**
     * fix methods in the 'after'|'before' part of definition
     *
     * @param  array        $line
     * @param  object|array $object  or object definition
     * @return array  [Callable, arguments]
     * @throws LogicException   if definition went wrong
     */
    protected function fixMethod(array $line, $object): array
    {
        // callable found
        if (is_callable($line[0])) {
            $callable = $line[0];
            $arguments = (array) ($line[1] ?? [$object]);
            // object method found [$object, 'method']
        } elseif (is_string($line[0]) && is_object($object) && method_exists($object, $line[0])) {
            $callable = [$object, $line[0]];
            $arguments = (array) ($line[1] ?? []);
            // nothing right
        } else {
            throw new LogicException("Bad method definition: $line");
        }
        return [$callable, $arguments];
    }
}