BackgroundImageBaseCacheContext.php in Background Image 2.0.x

Namespace

Drupal\background_image\Cache\Context

File

src/Cache/Context/BackgroundImageBaseCacheContext.php

<?php

namespace Drupal\background_image\Cache\Context;

use Drupal\background_image\BackgroundImageManagerInterface;
use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Cache\Context\CacheContextInterface;

/**
 * Provides a base for Background Image based contexts.
 */
abstract class BackgroundImageBaseCacheContext implements CacheContextInterface {

  /**
   * @var \Drupal\background_image\BackgroundImageManagerInterface
   */
  protected $manager;

  /**
   * @var \Drupal\background_image\BackgroundImageInterface|null
   */
  protected $backgroundImage;

  /**
   * Constructs a BackgroundImageCacheContext object.
   *
   * @param \Drupal\background_image\BackgroundImageManagerInterface $background_image_manager
   */
  public function __construct(BackgroundImageManagerInterface $background_image_manager) {
    $this->manager = $background_image_manager;
    $this->backgroundImage = $background_image_manager
      ->getBackgroundImage();
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheableMetadata() {
    $metadata = new CacheableMetadata();
    if ($this->backgroundImage) {
      $metadata
        ->addCacheTags($this->backgroundImage
        ->getCacheTags());
    }
    return $metadata;
  }

}

Classes

Name	Description
BackgroundImageBaseCacheContext	Provides a base for Background Image based contexts.