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

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\Routing\Loader;
  11. use Symfony\Component\Config\Loader\Loader;
  12. use Symfony\Component\Config\Resource\FileResource;
  13. use Symfony\Component\Routing\RouteCollection;
  14. /**
  15.  * A route loader that calls a method on an object to load the routes.
  16.  *
  17.  * @author Ryan Weaver <ryan@knpuniversity.com>
  18.  */
  19. abstract class ObjectLoader extends Loader
  20. {
  21.     /**
  22.      * Returns the object that the method will be called on to load routes.
  23.      *
  24.      * For example, if your application uses a service container,
  25.      * the $id may be a service id.
  26.      *
  27.      * @return object
  28.      */
  29.     abstract protected function getObject(string $id);
  30.     /**
  31.      * Calls the object method that will load the routes.
  32.      *
  33.      * @param string      $resource object_id::method
  34.      * @param string|null $type     The resource type
  35.      *
  36.      * @return RouteCollection
  37.      */
  38.     public function load($resourcestring $type null)
  39.     {
  40.         if (!preg_match('/^[^\:]+(?:::(?:[^\:]+))?$/'$resource)) {
  41.             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'));
  42.         }
  43.         $parts explode('::'$resource);
  44.         $method $parts[1] ?? '__invoke';
  45.         $loaderObject $this->getObject($parts[0]);
  46.         if (!\is_object($loaderObject)) {
  47.             throw new \TypeError(sprintf('"%s:getObject()" must return an object: "%s" returned.', static::class, get_debug_type($loaderObject)));
  48.         }
  49.         if (!\is_callable([$loaderObject$method])) {
  50.             throw new \BadMethodCallException(sprintf('Method "%s" not found on "%s" when importing routing resource "%s".'$methodget_debug_type($loaderObject), $resource));
  51.         }
  52.         $routeCollection $loaderObject->$method($this$this->env);
  53.         if (!$routeCollection instanceof RouteCollection) {
  54.             $type get_debug_type($routeCollection);
  55.             throw new \LogicException(sprintf('The "%s::%s()" method must return a RouteCollection: "%s" returned.'get_debug_type($loaderObject), $method$type));
  56.         }
  57.         // make the object file tracked so that if it changes, the cache rebuilds
  58.         $this->addClassResource(new \ReflectionClass($loaderObject), $routeCollection);
  59.         return $routeCollection;
  60.     }
  61.     private function addClassResource(\ReflectionClass $classRouteCollection $collection)
  62.     {
  63.         do {
  64.             if (is_file($class->getFileName())) {
  65.                 $collection->addResource(new FileResource($class->getFileName()));
  66.             }
  67.         } while ($class $class->getParentClass());
  68.     }
  69. }