Drupal investigation

RouteCollectionBuilder.php 9.5KB

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