public function SystemMenuBlock::getCacheContexts in Drupal 8

Same name and namespace in other branches

1. 9 core/modules/system/src/Plugin/Block/SystemMenuBlock.php \Drupal\system\Plugin\Block\SystemMenuBlock::getCacheContexts()

The cache contexts associated with this object.

These identify a specific variation/representation of the object.

Cache contexts are tokens: placeholders that are converted to cache keys by the @cache_contexts_manager service. The replacement value depends on the request context (the current URL, language, and so on). They're converted before storing an object in cache.

Return value

string[] An array of cache context tokens, used to generate a cache ID.

Overrides ContextAwarePluginBase::getCacheContexts

See also

\Drupal\Core\Cache\Context\CacheContextsManager::convertTokensToKeys()

File

core/modules/system/src/Plugin/Block/SystemMenuBlock.php, line 228

Class

SystemMenuBlock

Provides a generic Menu block.

Namespace

Drupal\system\Plugin\Block

Code

public function getCacheContexts() {

  // ::build() uses MenuLinkTreeInterface::getCurrentRouteMenuTreeParameters()
  // to generate menu tree parameters, and those take the active menu trail
  // into account. Therefore, we must vary the rendered menu by the active
  // trail of the rendered menu.
  // Additional cache contexts, e.g. those that determine link text or
  // accessibility of a menu, will be bubbled automatically.
  $menu_name = $this
    ->getDerivativeId();
  return Cache::mergeContexts(parent::getCacheContexts(), [
    'route.menu_active_trails:' . $menu_name,
  ]);
}