class WorkspaceCacheContext in Multiversion 8

Defines the WorkspaceCacheContext service, for "per workspace" caching.

Cache context ID: 'workspace'.

Hierarchy

• class \Drupal\multiversion\WorkspaceCacheContext implements CacheContextInterface

1 string reference to 'WorkspaceCacheContext'

multiversion.services.yml in ./multiversion.services.yml

multiversion.services.yml

1 service uses WorkspaceCacheContext

cache_context.workspace in ./multiversion.services.yml

Drupal\multiversion\WorkspaceCacheContext

File

src/WorkspaceCacheContext.php, line 14

Namespace

Drupal\multiversion

class WorkspaceCacheContext implements CacheContextInterface {

  /**
   * The workspace manager.
   *
   * @var \Drupal\multiversion\Workspace\WorkspaceManagerInterface
   */
  protected $workspaceManager;

  /**
   * Constructs a new WorkspaceCacheContext service.
   *
   * @param \Drupal\multiversion\Workspace\WorkspaceManagerInterface $workspace_manager
   *   The workspace manager.
   */
  public function __construct(WorkspaceManagerInterface $workspace_manager) {
    $this->workspaceManager = $workspace_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function getLabel() {
    return t('Workspace');
  }

  /**
   * {@inheritdoc}
   */
  public function getContext() {
    return 'ws.' . $this->workspaceManager
      ->getActiveWorkspaceId();
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheableMetadata($type = NULL) {
    return new CacheableMetadata();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
WorkspaceCacheContext::$workspaceManager	protected	property	The workspace manager.
WorkspaceCacheContext::getCacheableMetadata	public	function	Gets the cacheability metadata for the context. Overrides CacheContextInterface::getCacheableMetadata
WorkspaceCacheContext::getContext	public	function	Returns the string representation of the cache context. Overrides CacheContextInterface::getContext
WorkspaceCacheContext::getLabel	public static	function	Returns the label of the cache context. Overrides CacheContextInterface::getLabel
WorkspaceCacheContext::__construct	public	function	Constructs a new WorkspaceCacheContext service.