class VariantBase

Same name in other branches
  1. 9 core/lib/Drupal/Core/Display/VariantBase.php \Drupal\Core\Display\VariantBase
  2. 8.9.x core/lib/Drupal/Core/Display/VariantBase.php \Drupal\Core\Display\VariantBase
  3. 10 core/lib/Drupal/Core/Display/VariantBase.php \Drupal\Core\Display\VariantBase

Provides a base class for DisplayVariant plugins.

Hierarchy

Expanded class hierarchy of VariantBase

See also

\Drupal\Core\Display\Attribute\DisplayVariant

\Drupal\Core\Display\VariantInterface

\Drupal\Core\Display\VariantManager

Plugin API

3 files declare their use of VariantBase
BlockPageVariant.php in core/modules/block/src/Plugin/DisplayVariant/BlockPageVariant.php
SimplePageVariant.php in core/lib/Drupal/Core/Render/Plugin/DisplayVariant/SimplePageVariant.php
TestDisplayVariant.php in core/modules/system/tests/modules/display_variant_test/src/Plugin/DisplayVariant/TestDisplayVariant.php

File

core/lib/Drupal/Core/Display/VariantBase.php, line 19

Namespace

Drupal\Core\Display
View source
abstract class VariantBase extends PluginBase implements VariantInterface {
    use PluginDependencyTrait;
    use RefinableCacheableDependencyTrait;
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->setConfiguration($configuration);
    }
    
    /**
     * {@inheritdoc}
     */
    public function label() {
        return $this->configuration['label'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function adminLabel() {
        return $this->pluginDefinition['admin_label'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function id() {
        return $this->configuration['uuid'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getWeight() {
        return (int) $this->configuration['weight'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function setWeight($weight) {
        $this->configuration['weight'] = (int) $weight;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfiguration() {
        return [
            'id' => $this->getPluginId(),
        ] + $this->configuration;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setConfiguration(array $configuration) {
        $this->configuration = $configuration + $this->defaultConfiguration();
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return [
            'label' => '',
            'uuid' => '',
            'weight' => 0,
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        return $this->dependencies;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
        $form['label'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Label'),
            '#description' => $this->t('The label for this display variant.'),
            '#default_value' => $this->label(),
            '#maxlength' => '255',
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
        $this->configuration['label'] = $form_state->getValue('label');
    }
    
    /**
     * {@inheritdoc}
     */
    public function access(?AccountInterface $account = NULL) {
        return TRUE;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::getCacheContexts public function 4
CacheableDependencyTrait::getCacheMaxAge public function 4
CacheableDependencyTrait::getCacheTags public function 4
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
VariantBase::access public function Determines if this display variant is accessible. Overrides VariantInterface::access
VariantBase::adminLabel public function Returns the admin-facing display variant label. Overrides VariantInterface::adminLabel
VariantBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
VariantBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
VariantBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
VariantBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
VariantBase::getWeight public function Returns the weight of the display variant. Overrides VariantInterface::getWeight
VariantBase::id public function Returns the unique ID for the display variant. Overrides VariantInterface::id
VariantBase::label public function Returns the user-facing display variant label. Overrides VariantInterface::label
VariantBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
VariantBase::setWeight public function Sets the weight of the display variant. Overrides VariantInterface::setWeight
VariantBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
VariantBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
VariantBase::__construct public function 1
VariantInterface::build public function Builds and returns the renderable array for the display variant. 3

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