4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\Routing\Loader
;
14 use Doctrine\Common\Annotations\Reader
;
15 use Symfony\Component\Config\
Resource\FileResource
;
16 use Symfony\Component\Routing\Route
;
17 use Symfony\Component\Routing\RouteCollection
;
18 use Symfony\Component\Config\Loader\LoaderInterface
;
19 use Symfony\Component\Config\Loader\LoaderResolverInterface
;
22 * AnnotationClassLoader loads routing information from a PHP class and its methods.
24 * You need to define an implementation for the getRouteDefaults() method. Most of the
25 * time, this method should define some PHP callable to be called for the route
26 * (a controller in MVC speak).
28 * The @Route annotation can be set on the class (for global parameters),
31 * The @Route annotation main value is the route path. The annotation also
32 * recognizes several parameters: requirements, options, defaults, schemes,
33 * methods, host, and name. The name parameter is mandatory.
34 * Here is an example of how you should be able to use it:
42 * * @Route("/", name="blog_index")
44 * public function index()
49 * * @Route("/{id}", name="blog_post", requirements = {"id" = "\d+"})
51 * public function show()
56 * @author Fabien Potencier <fabien@symfony.com>
58 abstract class AnnotationClassLoader
implements LoaderInterface
68 protected $routeAnnotationClass = 'Symfony\\Component\\Routing\\Annotation\\Route';
73 protected $defaultRouteIndex = 0;
78 * @param Reader $reader
80 public function __construct(Reader
$reader)
82 $this->reader
= $reader;
86 * Sets the annotation class to read route properties from.
88 * @param string $class A fully-qualified class name
90 public function setRouteAnnotationClass($class)
92 $this->routeAnnotationClass
= $class;
96 * Loads from annotations from a class.
98 * @param string $class A class name
99 * @param string|null $type The resource type
101 * @return RouteCollection A RouteCollection instance
103 * @throws \InvalidArgumentException When route can't be parsed
105 public function load($class, $type = null)
107 if (!class_exists($class)) {
108 throw new \
InvalidArgumentException(sprintf('Class "%s" does not exist.', $class));
113 'requirements' => array(),
114 'options' => array(),
115 'defaults' => array(),
116 'schemes' => array(),
117 'methods' => array(),
121 $class = new \
ReflectionClass($class);
122 if ($class->isAbstract()) {
123 throw new \
InvalidArgumentException(sprintf('Annotations from class "%s" cannot be read as it is abstract.', $class));
126 if ($annot = $this->reader
->getClassAnnotation($class, $this->routeAnnotationClass
)) {
128 if (null !== $annot->getPath()) {
129 $globals['path'] = $annot->getPath();
130 } elseif (null !== $annot->getPattern()) {
131 $globals['path'] = $annot->getPattern();
134 if (null !== $annot->getRequirements()) {
135 $globals['requirements'] = $annot->getRequirements();
138 if (null !== $annot->getOptions()) {
139 $globals['options'] = $annot->getOptions();
142 if (null !== $annot->getDefaults()) {
143 $globals['defaults'] = $annot->getDefaults();
146 if (null !== $annot->getSchemes()) {
147 $globals['schemes'] = $annot->getSchemes();
150 if (null !== $annot->getMethods()) {
151 $globals['methods'] = $annot->getMethods();
154 if (null !== $annot->getHost()) {
155 $globals['host'] = $annot->getHost();
159 $collection = new RouteCollection();
160 $collection->addResource(new FileResource($class->getFileName()));
162 foreach ($class->getMethods() as $method) {
163 $this->defaultRouteIndex
= 0;
164 foreach ($this->reader
->getMethodAnnotations($method) as $annot) {
165 if ($annot instanceof $this->routeAnnotationClass
) {
166 $this->addRoute($collection, $annot, $globals, $class, $method);
174 protected function addRoute(RouteCollection
$collection, $annot, $globals, \ReflectionClass
$class, \ReflectionMethod
$method)
176 $name = $annot->getName();
177 if (null === $name) {
178 $name = $this->getDefaultRouteName($class, $method);
181 $defaults = array_replace($globals['defaults'], $annot->getDefaults());
182 foreach ($method->getParameters() as $param) {
183 if ($param->isOptional()) {
184 $defaults[$param->getName()] = $param->getDefaultValue();
187 $requirements = array_replace($globals['requirements'], $annot->getRequirements());
188 $options = array_replace($globals['options'], $annot->getOptions());
189 $schemes = array_replace($globals['schemes'], $annot->getSchemes());
190 $methods = array_replace($globals['methods'], $annot->getMethods());
192 $host = $annot->getHost();
193 if (null === $host) {
194 $host = $globals['host'];
197 $route = new Route($globals['path'].$annot->getPath(), $defaults, $requirements, $options, $host, $schemes, $methods);
199 $this->configureRoute($route, $class, $method, $annot);
201 $collection->add($name, $route);
207 public function supports($resource, $type = null)
209 return is_string($resource) && preg_match('/^(?:\\\\?[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)+$/', $resource) && (!$type || 'annotation' === $type);
215 public function setResolver(LoaderResolverInterface
$resolver)
222 public function getResolver()
227 * Gets the default route name for a class method.
229 * @param \ReflectionClass $class
230 * @param \ReflectionMethod $method
234 protected function getDefaultRouteName(\ReflectionClass
$class, \ReflectionMethod
$method)
236 $name = strtolower(str_replace('\\', '_', $class->name
).'_'.$method->name
);
237 if ($this->defaultRouteIndex
> 0) {
238 $name .= '_'.$this->defaultRouteIndex
;
240 $this->defaultRouteIndex++
;
245 abstract protected function configureRoute(Route
$route, \ReflectionClass
$class, \ReflectionMethod
$method, $annot);