class MockRouteProvider

Same name in other branches
  1. 9 core/modules/system/src/Tests/Routing/MockRouteProvider.php \Drupal\system\Tests\Routing\MockRouteProvider
  2. 10 core/modules/system/src/Tests/Routing/MockRouteProvider.php \Drupal\system\Tests\Routing\MockRouteProvider
  3. 11.x core/modules/system/src/Tests/Routing/MockRouteProvider.php \Drupal\system\Tests\Routing\MockRouteProvider

Easily configurable mock route provider.

Hierarchy

Expanded class hierarchy of MockRouteProvider

1 file declares its use of MockRouteProvider
SystemMenuBlockTest.php in core/modules/system/tests/src/Kernel/Block/SystemMenuBlockTest.php

File

core/modules/system/src/Tests/Routing/MockRouteProvider.php, line 13

Namespace

Drupal\system\Tests\Routing
View source 
class MockRouteProvider implements RouteProviderInterface {
    
    /**
     * A collection of routes for this route provider.
     *
     * @var \Symfony\Component\Routing\RouteCollection
     */
    protected $routes;
    
    /**
     * Constructs a new MockRouteProvider.
     *
     * @param \Symfony\Component\Routing\RouteCollection $routes
     *   The route collection to use for this provider.
     */
    public function __construct(RouteCollection $routes) {
        $this->routes = $routes;
    }
    
    /**
     * Implements \Symfony\Cmf\Component\Routing\RouteProviderInterface::getRouteCollectionForRequest().
     *
     * Simply return all routes to prevent
     * \Symfony\Component\Routing\Exception\ResourceNotFoundException.
     */
    public function getRouteCollectionForRequest(Request $request) {
        return $this->routes;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRouteByName($name) {
        $routes = $this->getRoutesByNames([
            $name,
        ]);
        if (empty($routes)) {
            throw new RouteNotFoundException(sprintf('Route "%s" does not exist.', $name));
        }
        return reset($routes);
    }
    
    /**
     * {@inheritdoc}
     */
    public function preLoadRoutes($names) {
        // Nothing to do.
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRoutesByNames($names) {
        $routes = [];
        foreach ($names as $name) {
            $routes[] = $this->routes
                ->get($name);
        }
        return $routes;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRoutesByPattern($pattern) {
        return new RouteCollection();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getAllRoutes() {
        return $this->routes
            ->all();
    }
    
    /**
     * {@inheritdoc}
     */
    public function reset() {
        $this->routes = [];
    }

}

Members

Title Modifiers Object type Summary Overriden Title
MockRouteProvider::$routes protected property A collection of routes for this route provider.
MockRouteProvider::getAllRoutes public function Returns all the routes on the system. Overrides RouteProviderInterface::getAllRoutes
MockRouteProvider::getRouteByName public function
MockRouteProvider::getRouteCollectionForRequest public function Implements \Symfony\Cmf\Component\Routing\RouteProviderInterface::getRouteCollectionForRequest().
MockRouteProvider::getRoutesByNames public function
MockRouteProvider::getRoutesByPattern public function Get all routes which match a certain pattern. Overrides RouteProviderInterface::getRoutesByPattern
MockRouteProvider::preLoadRoutes public function
MockRouteProvider::reset public function Resets the route provider object. Overrides RouteProviderInterface::reset
MockRouteProvider::__construct public function Constructs a new MockRouteProvider.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.