You are here

Home » API reference » Display Suite 8.4 » Entity.php

abstract class Entity in Display Suite 8.4

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

Renders an entity by a given view mode.

Hierarchy

Expanded class hierarchy of Entity

2 files declare their use of Entity
CommentUser.php in src/Plugin/DsField/Comment/CommentUser.php
User.php in src/Plugin/DsField/User/User.php
1 string reference to 'Entity'
ds.field.schema.yml in config/schema/ds.field.schema.yml
config/schema/ds.field.schema.yml

File

src/Plugin/DsField/Entity.php, line 12

Namespace

Drupal\ds\Plugin\DsField
View source 
abstract class Entity extends DsFieldBase {

  /**
   * The EntityDisplayRepository service.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * Constructs a Display Suite field plugin.
   */
  public function __construct($configuration, $plugin_id, $plugin_definition, EntityDisplayRepositoryInterface $entity_display_repository) {
    $this->entityDisplayRepository = $entity_display_repository;
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_display.repository'));
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm($form, FormStateInterface $form_state) {
    $entity = $this
      ->linkedEntity();
    $view_modes = $this->entityDisplayRepository
      ->getViewModes($entity);
    $options = [];
    foreach ($view_modes as $id => $view_mode) {
      $options[$id] = $view_mode['label'];
    }
    $config = $this
      ->getConfiguration();
    $form['entity_view_mode'] = [
      '#type' => 'select',
      '#title' => 'View mode',
      '#default_value' => $config['entity_view_mode'],
      '#options' => $options,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary($settings) {
    $entity = $this
      ->linkedEntity();
    $view_modes = $this->entityDisplayRepository
      ->getViewModes($entity);

    // When no view modes are found no summary is displayed.
    if (empty($view_modes)) {
      return [];
    }

    // Print the chosen view mode or the default one.
    $config = $this
      ->getConfiguration();
    $entity_view_mode = $config['entity_view_mode'];
    $summary[] = 'View mode: ' . $view_modes[$entity_view_mode]['label'];
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $entity = $this
      ->linkedEntity();
    $view_modes = $this->entityDisplayRepository
      ->getViewModes($entity);
    reset($view_modes);
    $default_view_mode = key($view_modes);
    $configuration = [
      'entity_view_mode' => $default_view_mode,
    ];
    return $configuration;
  }

  /**
   * Gets the wanted entity.
   */
  public function linkedEntity() {
    return '';
  }

  /**
   * Gets the view mode.
   */
  public function getEntityViewMode() {
    $config = $this
      ->getConfiguration();
    return $config['entity_view_mode'];
  }

}

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 25
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::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 3
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 3
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::viewMode public function Gets the view mode. Overrides DsFieldInterface::viewMode
Entity::$entityDisplayRepository protected property The EntityDisplayRepository service.
Entity::create public static function Creates an instance of the plugin. Overrides DsFieldBase::create 2
Entity::defaultConfiguration public function Gets default configuration for this plugin. Overrides DsFieldBase::defaultConfiguration
Entity::getEntityViewMode public function Gets the view mode.
Entity::linkedEntity public function Gets the wanted entity. 2
Entity::settingsForm public function The form that holds the settings for this plugin. Overrides DsFieldBase::settingsForm
Entity::settingsSummary public function Returns the summary of the chosen settings. Overrides DsFieldBase::settingsSummary
Entity::__construct public function Constructs a Display Suite field plugin. Overrides DsFieldBase::__construct 2
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.