gyselroth / micro-container

src/RuntimeContainer.php

<?php

declare(strict_types=1);

/**
 * Micro\Container
 *
 * @copyright   Copryright (c) 2018-2019 gyselroth GmbH (https://gyselroth.com)
 * @license     MIT https://opensource.org/licenses/MIT
 */

namespace Micro\Container;

use ProxyManager\Factory\LazyLoadingValueHolderFactory;
use Psr\Container\ContainerInterface;
use ReflectionClass;
use ReflectionMethod;
use ReflectionParameter;
use RuntimeException;

class RuntimeContainer
{
    /**
     * Config.
     *
     * @var Config
     */
    protected $config;

    /**
     * Service registry.
     *
     * @var array
     */
    protected $service = [];

    /**
     * Parent container.
     *
     * @var ContainerInterface|RuntimeContainer
     */
    protected $parent;

    /**
     * Children container.
     *
     * @var ContainerInterface[]
     */
    protected $children = [];

    /**
     * Parent service.
     *
     * @var mixed
     */
    protected $parent_service;

    /**
     * Create container.
     */
    public function __construct(iterable $config, $parent, ContainerInterface $interface)
    {
        $this->config = new Config($config, $this);
        $this->parent = $parent;
        $this->service[ContainerInterface::class] = $interface;
    }

    /**
     * Get parent container.
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * Set parent service on container.
     */
    public function setParentService($service)
    {
        $this->parent_service = $service;

        return $this;
    }

    /**
     * Get config.
     */
    public function getConfig(): Config
    {
        return $this->config;
    }

    /**
     * Get service.
     */
    public function get(string $name, ?array $parameters = null)
    {
        try {
            return $this->resolve($name, $parameters);
        } catch (Exception\ServiceNotFound $e) {
            return $this->wrapService($name, $parameters);
        }
    }

    /**
     * Resolve service.
     */
    public function resolve(string $name, ?array $parameters = null)
    {
        if (isset($this->service[$name])) {
            return $this->service[$name];
        }

        if ($this->config->has($name)) {
            return $this->wrapService($name, $parameters);
        }

        if (null !== $this->parent_service) {
            $parents = array_merge([$name], class_implements($this->parent_service), class_parents($this->parent_service));

            if (in_array($name, $parents, true) && $this->parent_service instanceof $name) {
                return $this->parent_service;
            }
        }

        if (null !== $this->parent) {
            return $this->parent->resolve($name, $parameters);

The method resolve() does not exist on Psr\Container\ContainerInterface.

        }

        throw new Exception\ServiceNotFound("service $name was not found in service tree");
    }

    /**
     * Store service.
     */
    protected function storeService(string $name, array $config, $service)
    {
        if (false === $config['singleton']) {
            return $service;
        }
        $this->service[$name] = $service;

        if (isset($this->children[$name])) {
            $this->children[$name]->setParentService($service);

The method setParentService() does not exist on Psr\Container\ContainerInterface.

        }

        return $service;
    }

    /**
     * Wrap resolved service in callable if enabled.
     */
    protected function wrapService(string $name, ?array $parameters = null)
    {
        $config = $this->config->get($name);
        if (true === $config['wrap']) {
            $that = $this;

            return function () use ($that, $name, $parameters) {
                return $that->autoWireClass($name, $parameters);
            };
        }

        return $this->autoWireClass($name, $parameters);
    }

    /**
     * Auto wire.
     */
    protected function autoWireClass(string $name, ?array $parameters = null)
    {
        $config = $this->config->get($name);
        $class = $config['use'];

        if (null !== $parameters) {
            $config['singleton'] = false;
        }

        if (preg_match('#^\{([^{}]+)\}$#', $class, $match)) {
            return $this->wireReference($name, $match[1], $config);
        }

        $reflection = new ReflectionClass($class);

        if (isset($config['factory'])) {
            $factory = $reflection->getMethod($config['factory']);
            $args = $this->autoWireMethod($name, $factory, $config, $parameters);
            $instance = call_user_func_array([$class, $config['factory']], $args);

            return $this->prepareService($name, $instance, $reflection, $config);
        }

        $constructor = $reflection->getConstructor();

        if (null === $constructor) {
            return $this->createInstance($name, $reflection, [], $config);
        }

        $args = $this->autoWireMethod($name, $constructor, $config, $parameters);

        return $this->createInstance($name, $reflection, $args, $config);
    }

    /**
     * Wire named referenced service.
     */
    protected function wireReference(string $name, string $reference, array $config)
    {
        $service = $this->get($reference);
        $reflection = new ReflectionClass(get_class($service));
        $config = $this->config->get($name);
        $service = $this->prepareService($name, $service, $reflection, $config);

        return $service;
    }

    /**
     * Get instance (virtual or real instance).
     */
    protected function createInstance(string $name, ReflectionClass $class, array $arguments, array $config)
    {
        if (true === $config['lazy']) {
            return $this->getProxyInstance($name, $class, $arguments, $config);
        }

        return $this->getRealInstance($name, $class, $arguments, $config);
    }

    /**
     * Create proxy instance.
     */
    protected function getProxyInstance(string $name, ReflectionClass $class, array $arguments, array $config)
    {
        $factory = new LazyLoadingValueHolderFactory();
        $that = $this;

        return $factory->createProxy(
            $class->getName(),
            function (&$wrappedObject, $proxy, $method, $parameters, &$initializer) use ($that, $name,$class,$arguments,$config) {
                $wrappedObject = $that->getRealInstance($name, $class, $arguments, $config);
                $initializer = null;
            }
        );
    }

    /**
     * Create real instance.
     */
    protected function getRealInstance(string $name, ReflectionClass $class, array $arguments, array $config)
    {
        $instance = $class->newInstanceArgs($arguments);
        $instance = $this->prepareService($name, $instance, $class, $config);

        return $instance;
    }

    /**
     * Prepare service (execute sub selects and excute setter injections).
     */
    protected function prepareService(string $name, $service, ReflectionClass $class, array $config)
    {
        $this->storeService($name, $config, $service);

        foreach ($config['calls'] as $call) {
            if (!is_array($call)) {
                continue;
            }

            if (!isset($call['method'])) {
                throw new Exception\InvalidConfiguration('method is required for setter injection in service '.$name);
            }

            $arguments = [];
            $result = null;

            try {
                $method = $class->getMethod($call['method']);
            } catch (\ReflectionException $e) {
                throw new Exception\InvalidConfiguration('method '.$call['method'].' is not callable in class '.$class->getName().' for service '.$name);
            }

            if (isset($call['batch']) && is_array($call['batch'])) {
                foreach ($call['batch'] as $sub) {
                    $args = array_combine($call['arguments'], $sub);
                    $arguments = $this->autoWireMethod($name, $method, $call, $args);

It seems like $args can also be of type false; however, parameter $parameters of Micro\Container\RuntimeContainer::autoWireMethod() does only seem to accept array|null, maybe add an additional type check?

                    $result = call_user_func_array([&$service, $call['method']], $arguments);
                }
            } else {
                $arguments = $this->autoWireMethod($name, $method, $call);
                $result = call_user_func_array([&$service, $call['method']], $arguments);
            }

            if (isset($call['select']) && true === $call['select']) {
                $service = $result;
            }
        }

        $this->storeService($name, $config, $service);

        return $service;
    }

    /**
     * Autowire method.
     */
    protected function autoWireMethod(string $name, ReflectionMethod $method, array $config, ?array $parameters = null): array
    {
        $params = $method->getParameters();
        $args = [];

        foreach ($params as $param) {
            $type = $param->getClass();
            $param_name = $param->getName();

            $hint = $param->getType();
            if (null === $hint) {
                $hint = 'string';
            } else {
                $hint = $hint->getName();
            }

            if (isset($parameters[$param_name])) {
                $args[$param_name] = $parameters[$param_name];
            } elseif (isset($config['arguments'][$param_name])) {
                $args[$param_name] = $this->parseParam($config['arguments'][$param_name], $name, $hint);
            } elseif (null !== $type) {
                $args[$param_name] = $this->resolveServiceArgument($name, $type, $param);
            } elseif ($param->isDefaultValueAvailable()) {
                $args[$param_name] = $param->getDefaultValue();
            } elseif ($param->allowsNull()) {
                $args[$param_name] = null;
            } else {
                throw new Exception\InvalidConfiguration('no value found for argument '.$param_name.' in method '.$method->getName().' for service '.$name);
            }

            if (!$param->canBePassedByValue()) {
                $value = &$args[$param_name];
                $args[$param_name] = &$value;
            }
        }

        return $args;
    }

    /**
     * Resolve service argument.
     */
    protected function resolveServiceArgument(string $name, ReflectionClass $type, ReflectionParameter $param)
    {
        $type_class = $type->getName();

        if ($type_class === $name) {
            throw new RuntimeException('class '.$type_class.' can not depend on itself');
        }

        try {
            return $this->traverseTree($name, $type_class);
        } catch (\Exception $e) {
            if ($param->isDefaultValueAvailable() && null === $param->getDefaultValue()) {
                return null;
            }

            throw $e;
        }
    }

    /**
     * Parse param value.
     */
    protected function parseParam($param, string $name, string $type = 'string')
    {
        if (is_iterable($param)) {
            foreach ($param as $key => $value) {
                $param[$key] = $this->parseParam($value, $name, 'string');
            }

            return $param;
        }

        if (is_string($param)) {
            $param = $this->config->getEnv($param, $type);
            if (is_string($param)) {
                if (preg_match('#^\{\{([^{}]+)\}\}$#', $param, $matches)) {
                    return '{'.$matches[1].'}';
                }
                if (preg_match('#^\{([^{}]+)\}$#', $param, $matches)) {
                    return $this->traverseTree($name, $matches[1]);
                }
            }

            return $param;
        }
        if ($param instanceof \Closure) {
            $param = $param->bindTo($this);
        }

        return $param;
    }

    /**
     * Locate service.
     */
    protected function traverseTree(string $current_service, string $service)
    {
        if (isset($this->children[$current_service])) {
            return $this->children[$current_service]->get($service);
        }

        $config = $this->config->get($current_service);
        if (isset($config['services'])) {
            $this->children[$current_service] = new self($config['services'], $this, $this->service[ContainerInterface::class]);

            return $this->children[$current_service]->get($service);
        }

        return $this->get($service);
    }
}