class VariantBase
Same name in other branches
- 9 core/lib/Drupal/Core/Display/VariantBase.php \Drupal\Core\Display\VariantBase
- 8.9.x core/lib/Drupal/Core/Display/VariantBase.php \Drupal\Core\Display\VariantBase
- 11.x core/lib/Drupal/Core/Display/VariantBase.php \Drupal\Core\Display\VariantBase
Provides a base class for DisplayVariant plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Display\VariantBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Display\VariantInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Cache\RefinableCacheableDependencyTrait
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of VariantBase
See also
\Drupal\Core\Display\Attribute\DisplayVariant
\Drupal\Core\Display\VariantInterface
\Drupal\Core\Display\VariantManager
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\DisplayView 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
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.