You are here

Home » API reference » (Entity Reference) Field Formatters 8 » FieldFormatterFromViewDisplay.php

class FieldFormatterFromViewDisplay in (Entity Reference) Field Formatters 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Field/FieldFormatter/FieldFormatterFromViewDisplay.php \Drupal\field_formatter\Plugin\Field\FieldFormatter\FieldFormatterFromViewDisplay
  2. 3.x src/Plugin/Field/FieldFormatter/FieldFormatterFromViewDisplay.php \Drupal\field_formatter\Plugin\Field\FieldFormatter\FieldFormatterFromViewDisplay

Plugin implementation of the 'link' formatter.

Plugin annotation


@FieldFormatter(
  id = "field_formatter_from_view_display",
  label = @Translation("Field formatter from view display"),
  field_types = {
    "entity_reference"
  }
)

Hierarchy

Expanded class hierarchy of FieldFormatterFromViewDisplay

File

src/Plugin/Field/FieldFormatter/FieldFormatterFromViewDisplay.php, line 23

Namespace

Drupal\field_formatter\Plugin\Field\FieldFormatter
View source 
class FieldFormatterFromViewDisplay extends FieldFormatterBase implements ContainerFactoryPluginInterface {

  /**
   * Constructs a FieldFormatterFromViewDisplay object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Third party settings.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $settings = parent::defaultSettings() + [
      'view_mode' => 'default',
      'field_name' => '',
    ];
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $options = [];
    $er_target_entity_type = $this->fieldDefinition
      ->getSetting('target_type');
    $er_handler_settings = $this->fieldDefinition
      ->getSetting('handler_settings');
    if (!empty($er_handler_settings['target_bundles'])) {
      $er_target_bundles = $er_handler_settings['target_bundles'];
      foreach ($er_target_bundles as $er_target_bundle => $er_target_bundle_val) {
        $optionsByBundle = \Drupal::service('entity_display.repository')
          ->getViewModeOptionsByBundle($er_target_entity_type, $er_target_bundle);

        // Add option by key to prevent duplicates:
        foreach ($optionsByBundle as $key => $option) {
          $options[$key] = $option;
        }
      }
    }
    else {
      $options = \Drupal::service('entity_display.repository')
        ->getViewModeOptions($er_target_entity_type);
    }

    // Sort options in alphabetcial order:
    asort($options);
    $form['view_mode'] = [
      '#title' => $this
        ->t('View mode'),
      '#type' => 'select',
      '#options' => $options,
      '#default_value' => $this
        ->getSetting('view_mode'),
      '#empty_option' => 'Default',
      '#empty_value' => 'default',
    ];
    $form['field_name'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Field name'),
      '#default_value' => $this
        ->getSetting('field_name'),
      '#options' => $this
        ->getAvailableFieldNames(),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function getViewDisplay($bundle_id) {
    if (!isset($this->viewDisplay[$bundle_id])) {
      $field_name = $this
        ->getSetting('field_name');
      $entity_type_id = $this->fieldDefinition
        ->getSetting('target_type');
      if (($view_mode = $this
        ->getSetting('view_mode')) && ($view_display = EntityViewDisplay::load($entity_type_id . '.' . $bundle_id . '.' . $view_mode))) {

        /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $view_display */
        $components = $view_display
          ->getComponents();
        foreach ($components as $component_name => $component) {
          if ($component_name != $field_name) {
            $view_display
              ->removeComponent($component_name);
          }
        }
        $this->viewDisplay[$bundle_id] = $view_display;
      }
    }
    return $this->viewDisplay[$bundle_id];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    if ($view_mode = $this
      ->getSetting('view_mode')) {
      $summary[] = $this
        ->t('View display %view_mode used.', [
        '%view_mode' => $view_mode,
      ]);
    }
    else {
      $summary[] = $this
        ->t('View display not configured.');
    }
    return $summary;
  }

}

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
EntityReferenceFormatterBase::checkAccess protected function Checks access to the given entity. 3
EntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. 1
EntityReferenceFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. 1
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
FieldFormatterBase::$entityTypeManager protected property The entity type manager.
FieldFormatterBase::$viewDisplay protected property Entity view display.
FieldFormatterBase::getAvailableFieldNames protected function Gets list of supported fields.
FieldFormatterBase::getSettingFromFormState protected function Helper function to retrieve the $setting from the $form_state.
FieldFormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
FieldFormatterBase::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
FieldFormatterFromViewDisplay::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
FieldFormatterFromViewDisplay::defaultSettings public static function Defines the default settings for this plugin. Overrides FieldFormatterBase::defaultSettings
FieldFormatterFromViewDisplay::getViewDisplay protected function Gets entity view display for a bundle. Overrides FieldFormatterBase::getViewDisplay
FieldFormatterFromViewDisplay::settingsForm public function Returns a form to configure settings for the formatter. Overrides FieldFormatterBase::settingsForm
FieldFormatterFromViewDisplay::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FieldFormatterBase::settingsSummary
FieldFormatterFromViewDisplay::__construct public function Constructs a FieldFormatterFromViewDisplay object. Overrides FormatterBase::__construct
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.