You are here

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

abstract class FieldFormatterBase in (Entity Reference) Field Formatters 8

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

Base class for field formatters.

Hierarchy

Expanded class hierarchy of FieldFormatterBase

File

src/Plugin/Field/FieldFormatter/FieldFormatterBase.php, line 14

Namespace

Drupal\field_formatter\Plugin\Field\FieldFormatter
View source 
abstract class FieldFormatterBase extends EntityReferenceFormatterBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Entity view display.
   *
   * @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface
   */
  protected $viewDisplay;

  /**
   * Gets entity view display for a bundle.
   *
   * @param string $bundle_id
   *   The bundle ID.
   *
   * @return \Drupal\Core\Entity\Display\EntityViewDisplayInterface
   *   Entity view display.
   */
  protected abstract function getViewDisplay($bundle_id);

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return parent::defaultSettings() + [
      'link_to_entity' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $entity_type = $this->entityTypeManager
      ->getDefinition($this->fieldDefinition
      ->getTargetEntityTypeId());
    $form['link_to_entity'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Link to this @entity_label', [
        '@entity_label' => $entity_type
          ->getLabel(),
      ]),
      '#description' => $this
        ->t('Links the field to this (parent) entity (if supported by the field formatter, overriding referenced entity link settings).'),
      '#default_value' => $this
        ->getSetting('link_to_entity'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    if ($field_name = $this
      ->getSetting('field_name')) {
      $summary[] = $this
        ->t('Field %field_name displayed.', [
        '%field_name' => $field_name,
      ]);
    }
    else {
      $summary[] = $this
        ->t('Field not configured.');
    }
    if ($this
      ->getSetting('link_to_entity')) {
      $entity_type = $this->entityTypeManager
        ->getDefinition($this->fieldDefinition
        ->getTargetEntityTypeId());
      $summary[] = $this
        ->t('Linked to this (parent) @entity_label', [
        '@entity_label' => $entity_type
          ->getLabel(),
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {

    /** @var \Drupal\Core\Entity\FieldableEntityInterface $entity */
    $entities = $this
      ->getEntitiesToView($items, $langcode);
    $build = [];
    foreach ($entities as $delta => $entity) {
      $viewDisplay = $this
        ->getViewDisplay($entity
        ->bundle());
      if (!empty($viewDisplay)) {
        $entityDisplay = $viewDisplay
          ->build($entity);

        // Link to entity functionality:
        if ($this
          ->getSetting('link_to_entity') && ($entity = $items
          ->getEntity()) && $entity
          ->hasLinkTemplate('canonical') && !$entity
          ->isNew()) {
          $entityUrl = $entity
            ->toUrl();

          /*
          TODO: This implementation overwrites the ['#url'] value of the
          selected field, which only works for fields what support
          ['#url'] and has the advantage that no extra wrapper is created
          AND links in links are prevented. Anyway this will not work for
          all field types.
          */
          foreach ($entityDisplay as $field_name => &$field) {
            $field[0]['#url'] = $entityUrl;
          }

          /*
          TODO: Alternative from field_link formatter, which should
          work for all field types but may lead to links in links
          and additional wrapper markup.
          $field_name = $this->fieldDefinition->getName();
          $field_output = isset($entityDisplay[$field_name]) ?
          $entityDisplay[$field_name] : [];
          foreach (Element::children($field_output) as $key) {
            $entityDisplay[$field_name][$key] = [
              '#type' => 'link',
              '#url' => $entityUrl,
              '#title' => $field_output[$key],
            ];
          }
          */
        }
        $build[$delta] = $entityDisplay;
      }
    }
    return $build;
  }

  /**
   * Gets list of supported fields.
   *
   * @return array
   *   List of fields that are supported keyed by field machine name.
   */
  protected function getAvailableFieldNames() {
    $field_names = [];
    $entity_type_id = $this->fieldDefinition
      ->getSetting('target_type');

    /** @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface $bundle_info */
    $bundle_info = \Drupal::service('entity_type.bundle.info');
    $fieldDefinitionHandlerSettings = $this->fieldDefinition
      ->getSetting('handler_settings');
    $target_bundles = empty($fieldDefinitionHandlerSettings['target_bundles']) ? array_keys($bundle_info
      ->getBundleInfo($entity_type_id)) : $fieldDefinitionHandlerSettings['target_bundles'];
    foreach ($target_bundles as $value) {
      $bundle_field_names = array_map(function (FieldDefinitionInterface $field_definition) {
        return $field_definition
          ->getLabel();
      }, \Drupal::service('entity_field.manager')
        ->getFieldDefinitions($entity_type_id, $value));
      $field_names = array_merge($field_names, $bundle_field_names);
    }
    return $field_names;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $entity_type = \Drupal::entityTypeManager()
      ->getDefinition($field_definition
      ->getTargetEntityTypeId());
    return $entity_type
      ->isSubclassOf(FieldableEntityInterface::class);
  }

  /**
   * Helper function to retrieve the $setting from the $form_state.
   *
   * @param Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   * @param string $setting
   *   The setting key to retrieve.
   */
  protected function getSettingFromFormState(FormStateInterface $form_state, $setting) {
    $field_name = $this->fieldDefinition
      ->getName();
    if ($form_state
      ->hasValue([
      'fields',
      $field_name,
      'settings_edit_form',
      'settings',
      $setting,
    ])) {
      return $form_state
        ->getValue([
        'fields',
        $field_name,
        'settings_edit_form',
        'settings',
        $setting,
      ]);
    }
    return $this
      ->getSetting($setting);
  }

}

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::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings 2
FieldFormatterBase::getAvailableFieldNames protected function Gets list of supported fields.
FieldFormatterBase::getSettingFromFormState protected function Helper function to retrieve the $setting from the $form_state.
FieldFormatterBase::getViewDisplay abstract protected function Gets entity view display for a bundle. 2
FieldFormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
FieldFormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm 2
FieldFormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary 2
FieldFormatterBase::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
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.