interface PreloadableRouteProviderInterface

Same name in other branches
  1. 9 core/lib/Drupal/Core/Routing/PreloadableRouteProviderInterface.php \Drupal\Core\Routing\PreloadableRouteProviderInterface
  2. 8.9.x core/lib/Drupal/Core/Routing/PreloadableRouteProviderInterface.php \Drupal\Core\Routing\PreloadableRouteProviderInterface
  3. 10 core/lib/Drupal/Core/Routing/PreloadableRouteProviderInterface.php \Drupal\Core\Routing\PreloadableRouteProviderInterface

Extends the router provider interface to pre-load routes.

Hierarchy

Expanded class hierarchy of PreloadableRouteProviderInterface

All classes that implement PreloadableRouteProviderInterface

2 files declare their use of PreloadableRouteProviderInterface
MenuLinkTree.php in core/lib/Drupal/Core/Menu/MenuLinkTree.php
RouteProvider.php in core/tests/Drupal/KernelTests/RouteProvider.php

File

core/lib/Drupal/Core/Routing/PreloadableRouteProviderInterface.php, line 8

Namespace

Drupal\Core\Routing
View source 
interface PreloadableRouteProviderInterface extends RouteProviderInterface {
    
    /**
     * Pre-load routes by their names using the provided list of names.
     *
     * This method exists in order to allow performance optimizations. It allows
     * pre-loading serialized routes that may latter be retrieved using
     * ::getRoutesByName()
     *
     * @param string[] $names
     *   Array of route names to load.
     */
    public function preLoadRoutes($names);

}

Members

Title Modifiers Object type Summary Overrides
PreloadableRouteProviderInterface::preLoadRoutes public function Pre-load routes by their names using the provided list of names. 3
RouteProviderInterface::getAllRoutes public function Returns all the routes on the system. 4
RouteProviderInterface::getRouteByName public function Find the route using the provided route name. 4
RouteProviderInterface::getRouteCollectionForRequest public function Finds routes that may potentially match the request. 4
RouteProviderInterface::getRoutesByNames public function Find many routes by their names using the provided list of names. 4
RouteProviderInterface::getRoutesByPattern public function Get all routes which match a certain pattern. 4
RouteProviderInterface::reset public function Resets the route provider object. 4

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