Classes List

Symfony\Component\Routing\Loader\ObjectRouteLoader

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Routing\Loader;

use Symfony\Component\Config\Loader\Loader;
use Symfony\Component\Config\Resource\FileResource;
use Symfony\Component\Routing\RouteCollection;

/** * A route loader that calls a method on an object to load the routes. * * @author Ryan Weaver <ryan@knpuniversity.com> */
abstract class ObjectRouteLoader extends Loader
{
    /** * Returns the object that the method will be called on to load routes. * * For example, if your application uses a service container, * the $id may be a service id. * * @param string $id * * @return object */
    abstract protected function getServiceObject($id);

    /** * Calls the service that will load the routes. * * @param mixed $resource Some value that will resolve to a callable * @param string|null $type The resource type * * @return RouteCollection */
    public function load($resource$type = null)
    {
        $parts = explode(':'$resource);
        if (2 != count($parts)) {
            throw new \InvalidArgumentException(sprintf('Invalid resource "%s" passed to the "service" route loader: use the format "service_name:methodName"'$resource));
        }

        $serviceString = $parts[0];
        $method = $parts[1];

        $loaderObject = $this->getServiceObject($serviceString);

        if (!is_object($loaderObject)) {
            throw new \LogicException(sprintf('%s:getServiceObject() must return an object: %s returned'get_class($this), gettype($loaderObject)));
        }

        if (!method_exists($loaderObject$method)) {
            throw new \BadMethodCallException(sprintf('Method "%s" not found on "%s" when importing routing resource "%s"'$methodget_class($loaderObject), $resource));
        }

        $routeCollection = call_user_func(array($loaderObject$method), $this);

        if (!$routeCollection instanceof RouteCollection) {
            $type = is_object($routeCollection) ? get_class($routeCollection) : gettype($routeCollection);

            throw new \LogicException(sprintf('The %s::%s method must return a RouteCollection: %s returned'get_class($loaderObject), $method$type));
        }

        // make the service file tracked so that if it changes, the cache rebuilds
        $this->addClassResource(new \ReflectionClass($loaderObject), $routeCollection);

        return $routeCollection;
    }

    /** * {@inheritdoc} */
    public function supports($resource$type = null)
    {
        return 'service' === $type;
    }

    private function addClassResource(\ReflectionClass $classRouteCollection $collection)
    {
        do {
            if (is_file($class->getFileName())) {
                $collection->addResource(new FileResource($class->getFileName()));
            }
        } while ($class = $class->getParentClass());
    }
}