interface ContextAwareVariantInterface

Provides an interface for variant plugins that are context-aware.

Hierarchy

• interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\ConfigurablePluginInterface extends \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Cache\RefinableCacheableDependencyInterface extends \Drupal\Core\Cache\CacheableDependencyInterface; interface \Drupal\Core\Plugin\PluginFormInterface
  • interface \Drupal\Core\Display\VariantInterface extends \Drupal\Component\Plugin\PluginInspectionInterface \Drupal\Component\Plugin\ConfigurableInterface \Drupal\Component\Plugin\DependentPluginInterface \Drupal\Component\Plugin\ConfigurablePluginInterface \Drupal\Core\Plugin\PluginFormInterface \Drupal\Core\Cache\RefinableCacheableDependencyInterface
    • interface \Drupal\Core\Display\ContextAwareVariantInterface extends \Drupal\Core\Display\VariantInterface

Expanded class hierarchy of ContextAwareVariantInterface

All classes that implement ContextAwareVariantInterface

File

core/lib/Drupal/Core/Display/ContextAwareVariantInterface.php, line 8

Namespace

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);

}

Members