interface ContextAwareVariantInterface in Zircon Profile 8.0

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

Hierarchy

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

2 files declare their use of ContextAwareVariantInterface

HtmlRenderer.php in core/lib/Drupal/Core/Render/MainContent/HtmlRenderer.php

Contains \Drupal\Core\Render\MainContent\HtmlRenderer.

TestDisplayVariant.php in core/modules/system/tests/modules/display_variant_test/src/Plugin/DisplayVariant/TestDisplayVariant.php

Contains \Drupal\display_variant_test\Plugin\DisplayVariant\TestDisplayVariant.

File

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

Contains \Drupal\Core\Display\ContextAwareVariantInterface.

Namespace

Drupal\Core\Display

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

Name	Modifiers	Type	Description	Overrides
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	26
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	26
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	19
ConfigurablePluginInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	9
ConfigurablePluginInterface::getConfiguration	public	function	Gets this plugin's configuration.	10
ConfigurablePluginInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	10
ContextAwareVariantInterface::getContexts	public	function	Gets the values for all defined contexts.	1
ContextAwareVariantInterface::setContexts	public	function	Sets the context values for this display variant.	1
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	15
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	23
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	21
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	12
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	2
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.	1
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.	1
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.	1
VariantInterface::access	public	function	Determines if this display variant is accessible.	1
VariantInterface::adminLabel	public	function	Returns the admin-facing display variant label.	1
VariantInterface::build	public	function	Builds and returns the renderable array for the display variant.	3
VariantInterface::getWeight	public	function	Returns the weight of the display variant.	1
VariantInterface::id	public	function	Returns the unique ID for the display variant.	1
VariantInterface::label	public	function	Returns the user-facing display variant label.	1
VariantInterface::setWeight	public	function	Sets the weight of the display variant.	1