ServiceProviderRegistry.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\DependencyInjection;
 
use Psr\Container\ContainerInterface;
use ‪TYPO3\CMS\Core\Package\Package;
use TYPO3\CMS\Core\Package\PackageManager;
 
class ‪ServiceProviderRegistry implements \IteratorAggregate
{
    private ‪$packageManager;
 
    private ‪$failsafe;
 
    private ‪$instances;
 
    private ‪$serviceFactories = [];
 
    private ‪$serviceExtensions = [];
 
    public function ‪__construct(PackageManager ‪$packageManager, bool ‪$failsafe = false)
    {
        $this->packageManager = ‪$packageManager;
        $this->failsafe = ‪$failsafe;
    }
 
    public function ‪has(string $packageKey): bool
    {
        if (isset($this->instances[$packageKey])) {
            return true;
        }
 
        if ($this->packageManager->isPackageActive($packageKey)) {
            if ($this->failsafe && $this->packageManager->getPackage($packageKey)->isPartOfMinimalUsableSystem() === false) {
                return false;
            }
            return true;
        }
 
        return false;
    }
 
    public function get(string $packageKey): ‪ServiceProviderInterface
    {
        return $this->instances[$packageKey] ?? $this->‪create($packageKey);
    }
 
    private function ‪create(string $packageKey, ‪Package $package = null): ‪ServiceProviderInterface
    {
        if ($package === null) {
            if (!$this->packageManager->isPackageActive($packageKey)) {
                throw new \InvalidArgumentException('Package ' . $packageKey . ' is not active', 1550351445);
            }
            $package = $this->packageManager->getPackage($packageKey);
        }
        $serviceProviderClassName = $package->getServiceProvider();
        $instance = new $serviceProviderClassName($package);
 
        if (!$instance instanceof ‪ServiceProviderInterface) {
            throw new \InvalidArgumentException('Service providers need to implement ' . ServiceProviderInterface::class, 1550302554);
        }
 
        return $this->instances[$packageKey] = $instance;
    }
 
    public function ‪getFactories(string $packageKey): array
    {
        return $this->serviceFactories[$packageKey] ?? ($this->serviceFactories[$packageKey] = $this->get($packageKey)->‪getFactories());
    }
 
    public function ‪getExtensions(string $packageKey): array
    {
        return $this->serviceExtensions[$packageKey] ?? ($this->serviceExtensions[$packageKey] = $this->get($packageKey)->‪getExtensions());
    }
 
    public function ‪createService(string $packageKey, string $serviceName, ContainerInterface $container)
    {
        $factory = $this->‪getFactories($packageKey)[$serviceName];
        return $factory($container);
    }
 
    public function ‪extendService(string $packageKey, string $serviceName, ContainerInterface $container, $previous = null)
    {
        $extension = $this->‪getExtensions($packageKey)[$serviceName];
        return $extension($container, $previous);
    }
 
    public function ‪getIterator(): \Generator
    {
        foreach ($this->packageManager->getActivePackages() as $package) {
            if ($this->failsafe && $package->isPartOfMinimalUsableSystem() === false) {
                continue;
            }
            $packageKey = $package->getPackageKey();
            yield $packageKey => ($this->instances[$packageKey] ?? $this->‪create($packageKey, $package));
        }
    }
}