class BookNavigationCacheContext in Drupal 9

Defines the book navigation cache context service.

Cache context ID: 'route.book_navigation'.

This allows for book navigation location-aware caching. It depends on:

• whether the current route represents a book node at all
• and if so, where in the book hierarchy we are

This class is container-aware to avoid initializing the 'book.manager' service when it is not necessary.

Hierarchy

• class \Drupal\book\Cache\BookNavigationCacheContext implements \Symfony\Component\DependencyInjection\ContainerAwareInterface, CacheContextInterface uses \Symfony\Component\DependencyInjection\ContainerAwareTrait, DeprecatedServicePropertyTrait

1 file declares its use of BookNavigationCacheContext

BookTest.php in core/modules/book/tests/src/Functional/BookTest.php

1 string reference to 'BookNavigationCacheContext'

book.services.yml in core/modules/book/book.services.yml

core/modules/book/book.services.yml

1 service uses BookNavigationCacheContext

cache_context.route.book_navigation in core/modules/book/book.services.yml

Drupal\book\Cache\BookNavigationCacheContext

File

core/modules/book/src/Cache/BookNavigationCacheContext.php, line 25

Namespace

Drupal\book\Cache

class BookNavigationCacheContext implements CacheContextInterface, ContainerAwareInterface {
  use ContainerAwareTrait;
  use DeprecatedServicePropertyTrait;

  /**
   * The current route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * {@inheritdoc}
   */
  protected $deprecatedProperties = [
    'request_stack' => 'request_stack',
  ];

  /**
   * Constructs a new BookNavigationCacheContext service.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The current route match.
   */
  public function __construct($route_match) {
    if (!$route_match instanceof RouteMatchInterface) {
      @trigger_error('Passing the request_stack service to ' . __METHOD__ . '() is deprecated in drupal:9.2.0 and will be removed before drupal:10.0.0. The parameter should be an instance of \\Drupal\\Core\\Routing\\RouteMatchInterface instead.', E_USER_DEPRECATED);
      $route_match = \Drupal::routeMatch();
    }
    $this->routeMatch = $route_match;
  }

  /**
   * {@inheritdoc}
   */
  public static function getLabel() {
    return t("Book navigation");
  }

  /**
   * {@inheritdoc}
   */
  public function getContext() {

    // Find the current book's ID.
    $current_bid = 0;
    $node = $this->routeMatch
      ->getParameter('node');
    if ($node instanceof NodeInterface && !empty($node->book['bid'])) {
      $current_bid = $node->book['bid'];
    }

    // If we're not looking at a book node, then we're not navigating a book.
    if ($current_bid === 0) {
      return 'book.none';
    }

    // If we're looking at a book node, get the trail for that node.
    $active_trail = $this->container
      ->get('book.manager')
      ->getActiveTrailIds($node->book['bid'], $node->book);
    return implode('|', $active_trail);
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheableMetadata() {

    // The book active trail depends on the node and data attached to it.
    // That information is however not stored as part of the node.
    $cacheable_metadata = new CacheableMetadata();
    $node = $this->routeMatch
      ->getParameter('node');
    if ($node instanceof NodeInterface) {

      // If the node is part of a book then we can use the cache tag for that
      // book. If not, then it can't be optimized away.
      if (!empty($node->book['bid'])) {
        $cacheable_metadata
          ->addCacheTags([
          'bid:' . $node->book['bid'],
        ]);
      }
      else {
        $cacheable_metadata
          ->setCacheMaxAge(0);
      }
    }
    return $cacheable_metadata;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BookNavigationCacheContext::$deprecatedProperties	protected	property
BookNavigationCacheContext::$routeMatch	protected	property	The current route match.
BookNavigationCacheContext::getCacheableMetadata	public	function	Gets the cacheability metadata for the context. Overrides CacheContextInterface::getCacheableMetadata
BookNavigationCacheContext::getContext	public	function	Returns the string representation of the cache context. Overrides CacheContextInterface::getContext
BookNavigationCacheContext::getLabel	public static	function	Returns the label of the cache context. Overrides CacheContextInterface::getLabel
BookNavigationCacheContext::__construct	public	function	Constructs a new BookNavigationCacheContext service.
DeprecatedServicePropertyTrait::__get	public	function	Allows to access deprecated/removed properties.