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