class MenuActiveTrailsCacheContext

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Cache/Context/MenuActiveTrailsCacheContext.php \Drupal\Core\Cache\Context\MenuActiveTrailsCacheContext
  2. 8.9.x core/lib/Drupal/Core/Cache/Context/MenuActiveTrailsCacheContext.php \Drupal\Core\Cache\Context\MenuActiveTrailsCacheContext
  3. 11.x core/lib/Drupal/Core/Cache/Context/MenuActiveTrailsCacheContext.php \Drupal\Core\Cache\Context\MenuActiveTrailsCacheContext

Defines the MenuActiveTrailsCacheContext service.

Hierarchy

Expanded class hierarchy of MenuActiveTrailsCacheContext

1 string reference to 'MenuActiveTrailsCacheContext'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses MenuActiveTrailsCacheContext
cache_context.route.menu_active_trails in core/core.services.yml
Drupal\Core\Cache\Context\MenuActiveTrailsCacheContext

File

core/lib/Drupal/Core/Cache/Context/MenuActiveTrailsCacheContext.php, line 11

Namespace

Drupal\Core\Cache\Context
View on git.drupalcode.org
View source 
class MenuActiveTrailsCacheContext implements CalculatedCacheContextInterface {
  
  /**
   * Constructs a MenuActiveTrailsCacheContext object.
   *
   * @param \Drupal\Core\Menu\MenuActiveTrailInterface|null $menuActiveTrailService
   *   The menu active trail service.
   */
  public function __construct(protected ?MenuActiveTrailInterface $menuActiveTrailService = NULL) {
    if ($this->menuActiveTrailService === NULL) {
      @trigger_error('Calling ' . __METHOD__ . ' without the $menuActiveTrailService argument is deprecated in drupal:10.2.0 and it will be required in drupal:11.0.0. See https://www.drupal.org/node/3397515', E_USER_DEPRECATED);
      $this->menuActiveTrailService = \Drupal::service('menu.active_trail');
    }
  }
  
  /**
   * {@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 Modifiers Object type Summary Overriden Title
MenuActiveTrailsCacheContext::getCacheableMetadata public function Gets the cacheability metadata for the context based on the parameter value. Overrides CalculatedCacheContextInterface::getCacheableMetadata
MenuActiveTrailsCacheContext::getContext public function Returns the string representation of the cache context. Overrides CalculatedCacheContextInterface::getContext
MenuActiveTrailsCacheContext::getLabel public static function Returns the label of the cache context. 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.