interface CacheableRouteProviderInterface in Drupal 10

Extends the router provider interface to provide caching support.

Hierarchy

• interface \Drupal\Core\Routing\RouteProviderInterface
  • interface \Drupal\Core\Routing\CacheableRouteProviderInterface

2 files declare their use of CacheableRouteProviderInterface

WorkspaceRequestSubscriber.php in core/modules/workspaces/src/EventSubscriber/WorkspaceRequestSubscriber.php

WorkspaceRequestSubscriberTest.php in core/modules/workspaces/tests/src/Unit/WorkspaceRequestSubscriberTest.php

File

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

Namespace

Drupal\Core\Routing

interface CacheableRouteProviderInterface extends RouteProviderInterface {

  /**
   * Adds a cache key part to be used in the cache ID of the route collection.
   *
   * @param string $cache_key_provider
   *   The provider of the cache key part.
   * @param string $cache_key_part
   *   A string to be used as a cache key part.
   */
  public function addExtraCacheKeyPart($cache_key_provider, $cache_key_part);

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableRouteProviderInterface::addExtraCacheKeyPart	public	function	Adds a cache key part to be used in the cache ID of the route collection.	1
RouteProviderInterface::getAllRoutes	public	function	Returns all the routes on the system.	3
RouteProviderInterface::getRouteByName	public	function	Find the route using the provided route name.	3
RouteProviderInterface::getRouteCollectionForRequest	public	function	Finds routes that may potentially match the request.	3
RouteProviderInterface::getRoutesByNames	public	function	Find many routes by their names using the provided list of names.	3
RouteProviderInterface::getRoutesByPattern	public	function	Get all routes which match a certain pattern.	3
RouteProviderInterface::reset	public	function	Resets the route provider object.	3