annotate core/modules/system/src/Tests/Routing/MockRouteProvider.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 7a779792577d
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\system\Tests\Routing;
Chris@0 4
Chris@0 5 use Symfony\Component\HttpFoundation\Request;
Chris@0 6 use Symfony\Component\Routing\Exception\RouteNotFoundException;
Chris@0 7 use Symfony\Component\Routing\RouteCollection;
Chris@0 8 use Drupal\Core\Routing\RouteProviderInterface;
Chris@0 9
Chris@0 10 /**
Chris@0 11 * Easily configurable mock route provider.
Chris@0 12 */
Chris@0 13 class MockRouteProvider implements RouteProviderInterface {
Chris@0 14
Chris@0 15 /**
Chris@0 16 * A collection of routes for this route provider.
Chris@0 17 *
Chris@12 18 * @var \Symfony\Component\Routing\RouteCollection
Chris@0 19 */
Chris@0 20 protected $routes;
Chris@0 21
Chris@0 22 /**
Chris@0 23 * Constructs a new MockRouteProvider.
Chris@0 24 *
Chris@0 25 * @param \Symfony\Component\Routing\RouteCollection $routes
Chris@0 26 * The route collection to use for this provider.
Chris@0 27 */
Chris@0 28 public function __construct(RouteCollection $routes) {
Chris@0 29 $this->routes = $routes;
Chris@0 30 }
Chris@0 31
Chris@0 32 /**
Chris@0 33 * Implements \Symfony\Cmf\Component\Routing\RouteProviderInterface::getRouteCollectionForRequest().
Chris@0 34 *
Chris@0 35 * Simply return all routes to prevent
Chris@0 36 * \Symfony\Component\Routing\Exception\ResourceNotFoundException.
Chris@0 37 */
Chris@0 38 public function getRouteCollectionForRequest(Request $request) {
Chris@0 39 return $this->routes;
Chris@0 40 }
Chris@0 41
Chris@0 42 /**
Chris@0 43 * {@inheritdoc}
Chris@0 44 */
Chris@0 45 public function getRouteByName($name) {
Chris@0 46 $routes = $this->getRoutesByNames([$name]);
Chris@0 47 if (empty($routes)) {
Chris@0 48 throw new RouteNotFoundException(sprintf('Route "%s" does not exist.', $name));
Chris@0 49 }
Chris@0 50
Chris@0 51 return reset($routes);
Chris@0 52 }
Chris@0 53
Chris@0 54 /**
Chris@0 55 * {@inheritdoc}
Chris@0 56 */
Chris@0 57 public function preLoadRoutes($names) {
Chris@0 58 // Nothing to do.
Chris@0 59 }
Chris@0 60
Chris@0 61 /**
Chris@0 62 * {@inheritdoc}
Chris@0 63 */
Chris@0 64 public function getRoutesByNames($names) {
Chris@0 65 $routes = [];
Chris@0 66 foreach ($names as $name) {
Chris@0 67 $routes[] = $this->routes->get($name);
Chris@0 68 }
Chris@0 69
Chris@0 70 return $routes;
Chris@0 71 }
Chris@0 72
Chris@0 73 /**
Chris@0 74 * {@inheritdoc}
Chris@0 75 */
Chris@0 76 public function getRoutesByPattern($pattern) {
Chris@0 77 return new RouteCollection();
Chris@0 78 }
Chris@0 79
Chris@0 80 /**
Chris@0 81 * {@inheritdoc}
Chris@0 82 */
Chris@0 83 public function getAllRoutes() {
Chris@0 84 return $this->routes->all();
Chris@0 85 }
Chris@0 86
Chris@0 87 /**
Chris@0 88 * {@inheritdoc}
Chris@0 89 */
Chris@0 90 public function reset() {
Chris@0 91 $this->routes = [];
Chris@0 92 }
Chris@0 93
Chris@0 94 }