CacheableRouteProviderInterface.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Routing/CacheableRouteProviderInterface.php
  2. 10 core/lib/Drupal/Core/Routing/CacheableRouteProviderInterface.php
  3. 11.x core/lib/Drupal/Core/Routing/CacheableRouteProviderInterface.php

Namespace

Drupal\Core\Routing

File

core/lib/Drupal/Core/Routing/CacheableRouteProviderInterface.php

View source
<?php

namespace Drupal\Core\Routing;


/**
 * Extends the router provider interface to provide caching support.
 */
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);

}

Interfaces

Title Deprecated Summary
CacheableRouteProviderInterface Extends the router provider interface to provide caching support.

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