MenuActiveTrailsCacheContext.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Cache/Context/MenuActiveTrailsCacheContext.php
  2. 10 core/lib/Drupal/Core/Cache/Context/MenuActiveTrailsCacheContext.php
  3. 11.x core/lib/Drupal/Core/Cache/Context/MenuActiveTrailsCacheContext.php

Namespace

Drupal\Core\Cache\Context

File

core/lib/Drupal/Core/Cache/Context/MenuActiveTrailsCacheContext.php

View source
<?php

namespace Drupal\Core\Cache\Context;

use Drupal\Core\Cache\CacheableMetadata;
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerAwareTrait;

/**
 * Defines the MenuActiveTrailsCacheContext service.
 *
 * This class is container-aware to avoid initializing the 'menu.active_trails'
 * service (and its dependencies) when it is not necessary.
 */
class MenuActiveTrailsCacheContext implements CalculatedCacheContextInterface, ContainerAwareInterface {
    use ContainerAwareTrait;
    
    /**
     * {@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->container
            ->get('menu.active_trail')
            ->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}",
        ]);
    }

}

Classes

Title Deprecated Summary
MenuActiveTrailsCacheContext Defines the MenuActiveTrailsCacheContext service.

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