RouteCollectionBuilder.php 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370
  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;
  11. use Symfony\Component\Config\Exception\FileLoaderLoadException;
  12. use Symfony\Component\Config\Loader\LoaderInterface;
  13. use Symfony\Component\Config\Resource\ResourceInterface;
  14. /**
  15. * Helps add and import routes into a RouteCollection.
  16. *
  17. * @author Ryan Weaver <ryan@knpuniversity.com>
  18. */
  19. class RouteCollectionBuilder
  20. {
  21. /**
  22. * @var Route[]|RouteCollectionBuilder[]
  23. */
  24. private $routes = array();
  25. private $loader;
  26. private $defaults = array();
  27. private $prefix;
  28. private $host;
  29. private $condition;
  30. private $requirements = array();
  31. private $options = array();
  32. private $schemes;
  33. private $methods;
  34. private $resources = array();
  35. public function __construct(LoaderInterface $loader = null)
  36. {
  37. $this->loader = $loader;
  38. }
  39. /**
  40. * Import an external routing resource and returns the RouteCollectionBuilder.
  41. *
  42. * $routes->import('blog.yml', '/blog');
  43. *
  44. * @param mixed $resource
  45. * @param string|null $prefix
  46. * @param string $type
  47. *
  48. * @return self
  49. *
  50. * @throws FileLoaderLoadException
  51. */
  52. public function import($resource, $prefix = '/', $type = null)
  53. {
  54. /** @var RouteCollection $collection */
  55. $collection = $this->load($resource, $type);
  56. // create a builder from the RouteCollection
  57. $builder = $this->createBuilder();
  58. foreach ($collection->all() as $name => $route) {
  59. $builder->addRoute($route, $name);
  60. }
  61. foreach ($collection->getResources() as $resource) {
  62. $builder->addResource($resource);
  63. }
  64. // mount into this builder
  65. $this->mount($prefix, $builder);
  66. return $builder;
  67. }
  68. /**
  69. * Adds a route and returns it for future modification.
  70. *
  71. * @param string $path The route path
  72. * @param string $controller The route's controller
  73. * @param string|null $name The name to give this route
  74. *
  75. * @return Route
  76. */
  77. public function add($path, $controller, $name = null)
  78. {
  79. $route = new Route($path);
  80. $route->setDefault('_controller', $controller);
  81. $this->addRoute($route, $name);
  82. return $route;
  83. }
  84. /**
  85. * Returns a RouteCollectionBuilder that can be configured and then added with mount().
  86. *
  87. * @return self
  88. */
  89. public function createBuilder()
  90. {
  91. return new self($this->loader);
  92. }
  93. /**
  94. * Add a RouteCollectionBuilder.
  95. *
  96. * @param string $prefix
  97. * @param RouteCollectionBuilder $builder
  98. */
  99. public function mount($prefix, RouteCollectionBuilder $builder)
  100. {
  101. $builder->prefix = trim(trim($prefix), '/');
  102. $this->routes[] = $builder;
  103. }
  104. /**
  105. * Adds a Route object to the builder.
  106. *
  107. * @param Route $route
  108. * @param string|null $name
  109. *
  110. * @return $this
  111. */
  112. public function addRoute(Route $route, $name = null)
  113. {
  114. if (null === $name) {
  115. // used as a flag to know which routes will need a name later
  116. $name = '_unnamed_route_'.spl_object_hash($route);
  117. }
  118. $this->routes[$name] = $route;
  119. return $this;
  120. }
  121. /**
  122. * Sets the host on all embedded routes (unless already set).
  123. *
  124. * @param string $pattern
  125. *
  126. * @return $this
  127. */
  128. public function setHost($pattern)
  129. {
  130. $this->host = $pattern;
  131. return $this;
  132. }
  133. /**
  134. * Sets a condition on all embedded routes (unless already set).
  135. *
  136. * @param string $condition
  137. *
  138. * @return $this
  139. */
  140. public function setCondition($condition)
  141. {
  142. $this->condition = $condition;
  143. return $this;
  144. }
  145. /**
  146. * Sets a default value that will be added to all embedded routes (unless that
  147. * default value is already set).
  148. *
  149. * @param string $key
  150. * @param mixed $value
  151. *
  152. * @return $this
  153. */
  154. public function setDefault($key, $value)
  155. {
  156. $this->defaults[$key] = $value;
  157. return $this;
  158. }
  159. /**
  160. * Sets a requirement that will be added to all embedded routes (unless that
  161. * requirement is already set).
  162. *
  163. * @param string $key
  164. * @param mixed $regex
  165. *
  166. * @return $this
  167. */
  168. public function setRequirement($key, $regex)
  169. {
  170. $this->requirements[$key] = $regex;
  171. return $this;
  172. }
  173. /**
  174. * Sets an opiton that will be added to all embedded routes (unless that
  175. * option is already set).
  176. *
  177. * @param string $key
  178. * @param mixed $value
  179. *
  180. * @return $this
  181. */
  182. public function setOption($key, $value)
  183. {
  184. $this->options[$key] = $value;
  185. return $this;
  186. }
  187. /**
  188. * Sets the schemes on all embedded routes (unless already set).
  189. *
  190. * @param array|string $schemes
  191. *
  192. * @return $this
  193. */
  194. public function setSchemes($schemes)
  195. {
  196. $this->schemes = $schemes;
  197. return $this;
  198. }
  199. /**
  200. * Sets the methods on all embedded routes (unless already set).
  201. *
  202. * @param array|string $methods
  203. *
  204. * @return $this
  205. */
  206. public function setMethods($methods)
  207. {
  208. $this->methods = $methods;
  209. return $this;
  210. }
  211. /**
  212. * Adds a resource for this collection.
  213. *
  214. * @param ResourceInterface $resource
  215. *
  216. * @return $this
  217. */
  218. private function addResource(ResourceInterface $resource)
  219. {
  220. $this->resources[] = $resource;
  221. return $this;
  222. }
  223. /**
  224. * Creates the final RouteCollection and returns it.
  225. *
  226. * @return RouteCollection
  227. */
  228. public function build()
  229. {
  230. $routeCollection = new RouteCollection();
  231. foreach ($this->routes as $name => $route) {
  232. if ($route instanceof Route) {
  233. $route->setDefaults(array_merge($this->defaults, $route->getDefaults()));
  234. $route->setOptions(array_merge($this->options, $route->getOptions()));
  235. // we're extra careful here to avoid re-setting deprecated _method and _scheme
  236. foreach ($this->requirements as $key => $val) {
  237. if (!$route->hasRequirement($key)) {
  238. $route->setRequirement($key, $val);
  239. }
  240. }
  241. if (null !== $this->prefix) {
  242. $route->setPath('/'.$this->prefix.$route->getPath());
  243. }
  244. if (!$route->getHost()) {
  245. $route->setHost($this->host);
  246. }
  247. if (!$route->getCondition()) {
  248. $route->setCondition($this->condition);
  249. }
  250. if (!$route->getSchemes()) {
  251. $route->setSchemes($this->schemes);
  252. }
  253. if (!$route->getMethods()) {
  254. $route->setMethods($this->methods);
  255. }
  256. // auto-generate the route name if it's been marked
  257. if ('_unnamed_route_' === substr($name, 0, 15)) {
  258. $name = $this->generateRouteName($route);
  259. }
  260. $routeCollection->add($name, $route);
  261. } else {
  262. /* @var self $route */
  263. $subCollection = $route->build();
  264. $subCollection->addPrefix($this->prefix);
  265. $routeCollection->addCollection($subCollection);
  266. }
  267. }
  268. foreach ($this->resources as $resource) {
  269. $routeCollection->addResource($resource);
  270. }
  271. return $routeCollection;
  272. }
  273. /**
  274. * Generates a route name based on details of this route.
  275. *
  276. * @return string
  277. */
  278. private function generateRouteName(Route $route)
  279. {
  280. $methods = implode('_', $route->getMethods()).'_';
  281. $routeName = $methods.$route->getPath();
  282. $routeName = str_replace(array('/', ':', '|', '-'), '_', $routeName);
  283. $routeName = preg_replace('/[^a-z0-9A-Z_.]+/', '', $routeName);
  284. // Collapse consecutive underscores down into a single underscore.
  285. $routeName = preg_replace('/_+/', '_', $routeName);
  286. return $routeName;
  287. }
  288. /**
  289. * Finds a loader able to load an imported resource and loads it.
  290. *
  291. * @param mixed $resource A resource
  292. * @param string|null $type The resource type or null if unknown
  293. *
  294. * @return RouteCollection
  295. *
  296. * @throws FileLoaderLoadException If no loader is found
  297. */
  298. private function load($resource, $type = null)
  299. {
  300. if (null === $this->loader) {
  301. throw new \BadMethodCallException('Cannot import other routing resources: you must pass a LoaderInterface when constructing RouteCollectionBuilder.');
  302. }
  303. if ($this->loader->supports($resource, $type)) {
  304. return $this->loader->load($resource, $type);
  305. }
  306. if (null === $resolver = $this->loader->getResolver()) {
  307. throw new FileLoaderLoadException($resource);
  308. }
  309. if (false === $loader = $resolver->resolve($resource, $type)) {
  310. throw new FileLoaderLoadException($resource);
  311. }
  312. return $loader->load($resource, $type);
  313. }
  314. }