vendor/symfony/routing/Loader/ObjectLoader.php line 43

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Routing\Loader;
  14. use Symfony\Component\Config\Loader\Loader;
  15. use Symfony\Component\Config\Resource\FileResource;
  16. use Symfony\Component\Routing\RouteCollection;
  18. /**
  19.  * A route loader that calls a method on an object to load the routes.
  20.  *
  21.  * @author Ryan Weaver <ryan@knpuniversity.com>
  22.  */
  23. abstract class ObjectLoader extends Loader
  24. {
  25.     /**
  26.      * Returns the object that the method will be called on to load routes.
  27.      *
  28.      * For example, if your application uses a service container,
  29.      * the $id may be a service id.
  30.      *
  31.      * @return object
  32.      */
  33.     abstract protected function getObject(string $id);
  35.     /**
  36.      * Calls the object method that will load the routes.
  37.      *
  38.      * @param string      $resource object_id::method
  39.      * @param string|null $type     The resource type
  40.      *
  41.      * @return RouteCollection
  42.      */
  43.     public function load($resource, $type = null)
  44.     {
  45.         if (!preg_match('/^[^\:]+(?:::?(?:[^\:]+))?$/', $resource)) {
  46.             throw new \InvalidArgumentException(sprintf('Invalid resource "%s" passed to the %s route loader: use the format "object_id::method" or "object_id" if your object class has an "__invoke" method.', $resource, \is_string($type) ? '"'.$type.'"' : 'object'));
  47.         }
  49.         if (1 === substr_count($resource, ':')) {
  50.             $resource = str_replace(':', '::', $resource);
  51.             @trigger_error(sprintf('Referencing object route loaders with a single colon is deprecated since Symfony 4.1. Use %s instead.', $resource), \E_USER_DEPRECATED);
  52.         }
  54.         $parts = explode('::', $resource);
  55.         $method = $parts[1] ?? '__invoke';
  57.         $loaderObject = $this->getObject($parts[0]);
  59.         if (!\is_object($loaderObject)) {
  60.             throw new \TypeError(sprintf('"%s:getObject()" must return an object: "%s" returned.', static::class, \gettype($loaderObject)));
  61.         }
  63.         if (!\is_callable([$loaderObject, $method])) {
  64.             throw new \BadMethodCallException(sprintf('Method "%s" not found on "%s" when importing routing resource "%s".', $method, \get_class($loaderObject), $resource));
  65.         }
  67.         $routeCollection = $loaderObject->$method($this);
  69.         if (!$routeCollection instanceof RouteCollection) {
  70.             $type = \is_object($routeCollection) ? \get_class($routeCollection) : \gettype($routeCollection);
  72.             throw new \LogicException(sprintf('The "%s::%s()" method must return a RouteCollection: "%s" returned.', \get_class($loaderObject), $method, $type));
  73.         }
  75.         // make the object file tracked so that if it changes, the cache rebuilds
  76.         $this->addClassResource(new \ReflectionClass($loaderObject), $routeCollection);
  78.         return $routeCollection;
  79.     }
  81.     private function addClassResource(\ReflectionClass $class, RouteCollection $collection)
  82.     {
  83.         do {
  84.             if (is_file($class->getFileName())) {
  85.                 $collection->addResource(new FileResource($class->getFileName()));
  86.             }
  87.         } while ($class = $class->getParentClass());
  88.     }
  89. }