class MenuActiveTrailsCacheContext
Same name in other branches
- 9 core/lib/Drupal/Core/Cache/Context/MenuActiveTrailsCacheContext.php \Drupal\Core\Cache\Context\MenuActiveTrailsCacheContext
- 8.9.x core/lib/Drupal/Core/Cache/Context/MenuActiveTrailsCacheContext.php \Drupal\Core\Cache\Context\MenuActiveTrailsCacheContext
- 10 core/lib/Drupal/Core/Cache/Context/MenuActiveTrailsCacheContext.php \Drupal\Core\Cache\Context\MenuActiveTrailsCacheContext
Defines the MenuActiveTrailsCacheContext service.
Hierarchy
- class \Drupal\Core\Cache\Context\MenuActiveTrailsCacheContext implements \Drupal\Core\Cache\Context\CalculatedCacheContextInterface
Expanded class hierarchy of MenuActiveTrailsCacheContext
File
-
core/
lib/ Drupal/ Core/ Cache/ Context/ MenuActiveTrailsCacheContext.php, line 11
Namespace
Drupal\Core\Cache\ContextView source
class MenuActiveTrailsCacheContext implements CalculatedCacheContextInterface {
/**
* Constructs a MenuActiveTrailsCacheContext object.
*
* @param \Drupal\Core\Menu\MenuActiveTrailInterface $menuActiveTrailService
* The menu active trail service.
*/
public function __construct(MenuActiveTrailInterface $menuActiveTrailService) {
}
/**
* {@inheritdoc}
*/
public static function getLabel() {
return t("Active menu trail");
}
/**
* {@inheritdoc}
*/
public function getContext($menu_name = NULL) {
if (!$menu_name) {
throw new \LogicException('No menu name provided for menu.active_trails cache context.');
}
$active_trail = $this->menuActiveTrailService
->getActiveTrailIds($menu_name);
return 'menu_trail.' . $menu_name . '|' . implode('|', $active_trail);
}
/**
* {@inheritdoc}
*/
public function getCacheableMetadata($menu_name = NULL) {
if (!$menu_name) {
throw new \LogicException('No menu name provided for menu.active_trails cache context.');
}
$cacheable_metadata = new CacheableMetadata();
return $cacheable_metadata->setCacheTags([
"config:system.menu.{$menu_name}",
]);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
MenuActiveTrailsCacheContext::getCacheableMetadata | public | function | Overrides CalculatedCacheContextInterface::getCacheableMetadata | |
MenuActiveTrailsCacheContext::getContext | public | function | Overrides CalculatedCacheContextInterface::getContext | |
MenuActiveTrailsCacheContext::getLabel | public static | function | Overrides CalculatedCacheContextInterface::getLabel | |
MenuActiveTrailsCacheContext::__construct | public | function | Constructs a MenuActiveTrailsCacheContext object. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.