VariantBase.php in Drupal 9
File
core/lib/Drupal/Core/Display/VariantBase.php
View source
<?php
namespace Drupal\Core\Display;
use Drupal\Core\Cache\RefinableCacheableDependencyTrait;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Plugin\PluginBase;
use Drupal\Core\Plugin\PluginDependencyTrait;
use Drupal\Core\Session\AccountInterface;
abstract class VariantBase extends PluginBase implements VariantInterface {
use PluginDependencyTrait;
use RefinableCacheableDependencyTrait;
public function __construct(array $configuration, $plugin_id, $plugin_definition) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this
->setConfiguration($configuration);
}
public function label() {
return $this->configuration['label'];
}
public function adminLabel() {
return $this->pluginDefinition['admin_label'];
}
public function id() {
return $this->configuration['uuid'];
}
public function getWeight() {
return (int) $this->configuration['weight'];
}
public function setWeight($weight) {
$this->configuration['weight'] = (int) $weight;
}
public function getConfiguration() {
return [
'id' => $this
->getPluginId(),
] + $this->configuration;
}
public function setConfiguration(array $configuration) {
$this->configuration = $configuration + $this
->defaultConfiguration();
return $this;
}
public function defaultConfiguration() {
return [
'label' => '',
'uuid' => '',
'weight' => 0,
];
}
public function calculateDependencies() {
return $this->dependencies;
}
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;
}
public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
}
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
$this->configuration['label'] = $form_state
->getValue('label');
}
public function access(AccountInterface $account = NULL) {
return TRUE;
}
}
Classes
Name |
Description |
VariantBase |
Provides a base class for DisplayVariant plugins. |