class TestRouteBuilder

Same name in other branches
  1. 9 core/tests/Drupal/Tests/Core/Routing/RouteBuilderTest.php \Drupal\Tests\Core\Routing\TestRouteBuilder
  2. 8.9.x core/tests/Drupal/Tests/Core/Routing/RouteBuilderTest.php \Drupal\Tests\Core\Routing\TestRouteBuilder
  3. 10 core/tests/Drupal/Tests/Core/Routing/RouteBuilderTest.php \Drupal\Tests\Core\Routing\TestRouteBuilder

Extends the core route builder with a setter method for the YAML discovery.

Hierarchy

Expanded class hierarchy of TestRouteBuilder

File

core/tests/Drupal/Tests/Core/Routing/RouteBuilderTest.php, line 327

Namespace

Drupal\Tests\Core\Routing
View source 
class TestRouteBuilder extends RouteBuilder {
    
    /**
     * The mocked YAML discovery.
     *
     * @var \Drupal\Core\Discovery\YamlDiscovery|\PHPUnit\Framework\MockObject\MockObject
     */
    protected $yamlDiscovery;
    
    /**
     * Sets the YAML discovery.
     *
     * @param \Drupal\Core\Discovery\YamlDiscovery $yaml_discovery
     *   The YAML discovery to set.
     */
    public function setYamlDiscovery(YamlDiscovery $yaml_discovery) : void {
        $this->yamlDiscovery = $yaml_discovery;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getRouteDefinitions() {
        return $this->yamlDiscovery
            ->findAll();
    }

}

Members

Title Modifiers Object type Summary Overriden Title
RouteBuilder::$building protected property Flag that indicates if we are currently rebuilding the routes.
RouteBuilder::$checkProvider protected property The check provider.
RouteBuilder::$controllerResolver protected property The controller resolver.
RouteBuilder::$dispatcher protected property The event dispatcher to notify of routes.
RouteBuilder::$dumper protected property The dumper to which we should send collected routes.
RouteBuilder::$lock protected property The used lock backend instance.
RouteBuilder::$moduleHandler protected property The module handler.
RouteBuilder::$rebuildNeeded protected property Flag that indicates if we should rebuild at the end of the request.
RouteBuilder::$routeCollection protected property The route collection during the rebuild.
RouteBuilder::destruct public function Performs destruct operations. Overrides DestructableInterface::destruct
RouteBuilder::rebuild public function Rebuilds the route information and dumps it. Overrides RouteBuilderInterface::rebuild
RouteBuilder::rebuildIfNeeded public function Rebuilds the route information if necessary, and dumps it. Overrides RouteBuilderInterface::rebuildIfNeeded
RouteBuilder::setRebuildNeeded public function Sets the router to be rebuilt next time rebuildIfNeeded() is called. Overrides RouteBuilderInterface::setRebuildNeeded
RouteBuilder::__construct public function Constructs the RouteBuilder using the passed MatcherDumperInterface.
TestRouteBuilder::$yamlDiscovery protected property The mocked YAML discovery.
TestRouteBuilder::getRouteDefinitions protected function Retrieves all defined routes from .routing.yml files. Overrides RouteBuilder::getRouteDefinitions
TestRouteBuilder::setYamlDiscovery public function Sets the YAML discovery.

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