interface VariantInterface in Drupal 9

Provides an interface for DisplayVariant plugins.

Hierarchy

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

See also

\Drupal\Core\Display\Annotation\DisplayVariant

\Drupal\Core\Display\VariantBase

\Drupal\Core\Display\VariantManager

Plugin API

File

core/lib/Drupal/Core/Display/VariantInterface.php, line 20

Namespace

Drupal\Core\Display

interface VariantInterface extends PluginInspectionInterface, ConfigurableInterface, DependentPluginInterface, PluginFormInterface, RefinableCacheableDependencyInterface {

  /**
   * Returns the user-facing display variant label.
   *
   * @return string
   *   The display variant label.
   */
  public function label();

  /**
   * Returns the admin-facing display variant label.
   *
   * This is for the type of display variant, not the configured variant itself.
   *
   * @return string
   *   The display variant administrative label.
   */
  public function adminLabel();

  /**
   * Returns the unique ID for the display variant.
   *
   * @return string
   *   The display variant ID.
   */
  public function id();

  /**
   * Returns the weight of the display variant.
   *
   * @return int
   *   The display variant weight.
   */
  public function getWeight();

  /**
   * Sets the weight of the display variant.
   *
   * @param int $weight
   *   The weight to set.
   */
  public function setWeight($weight);

  /**
   * Determines if this display variant is accessible.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   (optional) The user for which to check access, or NULL to check access
   *   for the current user. Defaults to NULL.
   *
   * @return bool
   *   TRUE if this display variant is accessible, FALSE otherwise.
   */
  public function access(AccountInterface $account = NULL);

  /**
   * Builds and returns the renderable array for the display variant.
   *
   * The variant can contain cacheability metadata for the configuration that
   * was passed in setConfiguration(). In the build() method, this should be
   * added to the render array that is returned.
   *
   * @return array
   *   A render array for the display variant.
   */
  public function build();

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	14
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	15
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	15
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	20
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	37
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
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