You are here

abstract class DsFieldBase in Display Suite 8.3

Same name and namespace in other branches
  1. 8.4 src/Plugin/DsField/DsFieldBase.php \Drupal\ds\Plugin\DsField\DsFieldBase
  2. 8.2 src/Plugin/DsField/DsFieldBase.php \Drupal\ds\Plugin\DsField\DsFieldBase

Base class for all the ds plugins.

Hierarchy

Expanded class hierarchy of DsFieldBase

18 files declare their use of DsFieldBase
BlockDescription.php in src/Plugin/DsField/Block/BlockDescription.php
BookNavigation.php in src/Plugin/DsField/Book/BookNavigation.php
ExampleField.php in drush/ExampleField.php
NodeAuthor.php in src/Plugin/DsField/Node/NodeAuthor.php
NodeLinks.php in src/Plugin/DsField/Node/NodeLinks.php

... See full list

File

src/Plugin/DsField/DsFieldBase.php, line 14

Namespace

Drupal\ds\Plugin\DsField
View source
abstract class DsFieldBase extends PluginBase implements DsFieldInterface, ConfigurableInterface, DependentPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->configuration += $this
      ->defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm($form, FormStateInterface $form_state) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary($settings) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return $this->configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = $configuration + $this->configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function formatters() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function isAllowed() {
    $definition = $this
      ->getPluginDefinition();
    if (!isset($definition['ui_limit'])) {
      return TRUE;
    }
    $limits = $definition['ui_limit'];
    foreach ($limits as $limit) {
      if (strpos($limit, '|') !== FALSE) {
        list($bundle_limit, $view_mode_limit) = explode('|', $limit);
        if (($bundle_limit == $this
          ->bundle() || $bundle_limit == '*') && ($view_mode_limit == $this
          ->viewMode() || $view_mode_limit == '*')) {
          return TRUE;
        }
      }
    }

    // When the current bundle view_mode combination is not allowed we shouldn't
    // show the field.
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function entity() {
    return $this->configuration['entity'];
  }

  /**
   * {@inheritdoc}
   */
  public function getEntityTypeId() {
    if (isset($this->configuration['entity_type'])) {
      return $this->configuration['entity_type'];
    }
    elseif ($entity = $this
      ->entity()) {
      return $entity
        ->getEntityTypeId();
    }
    else {
      return '';
    }
  }

  /**
   * {@inheritdoc}
   */
  public function bundle() {
    return $this->configuration['bundle'];
  }

  /**
   * {@inheritdoc}
   */
  public function viewMode() {
    return $this->configuration['view_mode'];
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldConfiguration() {
    return $this->configuration['field'];
  }

  /**
   * {@inheritdoc}
   */
  public function getName() {
    return $this->configuration['field_name'];
  }

  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    return $this->configuration['field']['title'];
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {

    // By default there are no dependencies.
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function isMultiple() {
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DsFieldBase::build public function Renders a field. Overrides DsFieldInterface::build 26
DsFieldBase::bundle public function Gets the current bundle. Overrides DsFieldInterface::bundle
DsFieldBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
DsFieldBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 7
DsFieldBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 6
DsFieldBase::entity public function Gets the current entity. Overrides DsFieldInterface::entity
DsFieldBase::formatters public function Returns a list of possible formatters for this field. Overrides DsFieldInterface::formatters 4
DsFieldBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration 1
DsFieldBase::getEntityTypeId public function Gets the current entity type. Overrides DsFieldInterface::getEntityTypeId
DsFieldBase::getFieldConfiguration public function Gets the field configuration. Overrides DsFieldInterface::getFieldConfiguration
DsFieldBase::getName public function Gets the field name. Overrides DsFieldInterface::getName
DsFieldBase::getTitle public function Returns the title of the field. Overrides DsFieldInterface::getTitle 1
DsFieldBase::isAllowed public function Returns if the field is allowed on the field UI screen. Overrides DsFieldInterface::isAllowed 4
DsFieldBase::isMultiple public function Defines if we are dealing with a multivalue field. Overrides DsFieldInterface::isMultiple 1
DsFieldBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 1
DsFieldBase::settingsForm public function The form that holds the settings for this plugin. Overrides DsFieldInterface::settingsForm 8
DsFieldBase::settingsSummary public function Returns the summary of the chosen settings. Overrides DsFieldInterface::settingsSummary 7
DsFieldBase::viewMode public function Gets the view mode. Overrides DsFieldInterface::viewMode
DsFieldBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 8
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.