ContextAwareVariantInterface.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Display/ContextAwareVariantInterface.php
  2. 10 core/lib/Drupal/Core/Display/ContextAwareVariantInterface.php
  3. 11.x core/lib/Drupal/Core/Display/ContextAwareVariantInterface.php

Namespace

Drupal\Core\Display

File

core/lib/Drupal/Core/Display/ContextAwareVariantInterface.php

View source
<?php

namespace Drupal\Core\Display;


/**
 * Provides an interface for variant plugins that are context-aware.
 */
interface ContextAwareVariantInterface extends VariantInterface {
    
    /**
     * Gets the values for all defined contexts.
     *
     * @return \Drupal\Component\Plugin\Context\ContextInterface[]
     *   An array of set contexts, keyed by context name.
     */
    public function getContexts();
    
    /**
     * Sets the context values for this display variant.
     *
     * @param \Drupal\Component\Plugin\Context\ContextInterface[] $contexts
     *   An array of contexts, keyed by context name.
     *
     * @return $this
     */
    public function setContexts(array $contexts);

}

Interfaces

Title Deprecated Summary
ContextAwareVariantInterface Provides an interface for variant plugins that are context-aware.

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