vendor/pimcore/pimcore/lib/Loader/ImplementationLoader/ImplementationLoader.php line 110

Open in your IDE?
  1. <?php
  3. declare(strict_types = 1);
  5. /**
  6.  * Pimcore
  7.  *
  8.  * This source file is available under two different licenses:
  9.  * - GNU General Public License version 3 (GPLv3)
  10.  * - Pimcore Commercial License (PCL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  16.  */
  18. namespace Pimcore\Loader\ImplementationLoader;
  20. use Pimcore\Loader\ImplementationLoader\Exception\UnsupportedException;
  22. /**
  23.  * Core implementation loader delegating to a list of registered loaders
  24.  *
  25.  * @internal
  26.  */
  27. class ImplementationLoader implements LoaderInterface, ClassNameLoaderInterface
  28. {
  29.     /**
  30.      * @var LoaderInterface[]
  31.      */
  32.     protected $loaders;
  34.     /**
  35.      * @var array
  36.      */
  37.     private $loaderCache = [];
  39.     /**
  40.      * @param LoaderInterface[] $loaders
  41.      */
  42.     public function __construct(array $loaders = [])
  43.     {
  44.         $this->setLoaders($loaders);
  45.     }
  47.     /**
  48.      * @param LoaderInterface[] $loaders
  49.      */
  50.     private function setLoaders(array $loaders)
  51.     {
  52.         $this->loaders = [];
  53.         $this->loaderCache = [];
  55.         foreach ($loaders as $loader) {
  56.             $this->addLoader($loader);
  57.         }
  58.     }
  60.     /**
  61.      * @param LoaderInterface $loader
  62.      */
  63.     public function addLoader(LoaderInterface $loader)
  64.     {
  65.         $this->loaders[] = $loader;
  66.     }
  68.     /**
  69.      * @param string $name
  70.      *
  71.      * @return LoaderInterface|null
  72.      */
  73.     private function getLoader(string $name)
  74.     {
  75.         // loader cache contains index of loader previously found for given name
  76.         if (isset($this->loaderCache[$name])) {
  77.             return $this->loaders[$this->loaderCache[$name]];
  78.         }
  80.         /** @var LoaderInterface $loader */
  81.         foreach (array_reverse($this->loaders, true) as $idx => $loader) {
  82.             if ($loader->supports($name)) {
  83.                 $this->loaderCache[$name] = $idx;
  85.                 return $loader;
  86.             }
  87.         }
  89.         return null;
  90.     }
  92.     /**
  93.      * {@inheritdoc}
  94.      */
  95.     public function supports(string $name): bool
  96.     {
  97.         return null !== $this->getLoader($name);
  98.     }
  100.     /**
  101.      * {@inheritdoc}
  102.      */
  103.     public function build(string $name, array $params = [])
  104.     {
  105.         $loader = $this->getLoader($name);
  106.         if (null === $loader) {
  107.             throw new UnsupportedException(sprintf('Loader for "%s" was not found', $name));
  108.         }
  110.         return $loader->build($name, $params);
  111.     }
  113.     /**
  114.      * {@inheritdoc}
  115.      */
  116.     public function supportsClassName(string $name): bool
  117.     {
  118.         $loader = $this->getLoader($name);
  120.         if (null === $loader || !$loader instanceof ClassNameLoaderInterface) {
  121.             return false;
  122.         }
  124.         return $loader->supportsClassName($name);
  125.     }
  127.     /**
  128.      * {@inheritdoc}
  129.      */
  130.     public function getClassNameFor(string $name): string
  131.     {
  132.         $loader = $this->getLoader($name);
  133.         if (null === $loader) {
  134.             throw new UnsupportedException(sprintf('Loader for "%s" was not found', $name));
  135.         }
  137.         if (!$loader instanceof ClassNameLoaderInterface) {
  138.             throw new UnsupportedException(sprintf(
  139.                 'Loader "%s" for "%s" does not support building a class name',
  140.                 get_class($loader),
  141.                 $name
  142.             ));
  143.         }
  145.         if (!$loader->supportsClassName($name)) {
  146.             throw new UnsupportedException(sprintf(
  147.                 'Building a class name for "%s" from loader "%s" is not supported',
  148.                 $name,
  149.                 get_class($loader)
  150.             ));
  151.         }
  153.         return $loader->getClassNameFor($name);
  154.     }
  155. }