You are here

Home » API reference » Reference Table Formatter 2.0.x » EntityReferenceTableFormatter.php

class EntityReferenceTableFormatter in Reference Table Formatter 2.0.x

A field formatter to display a table.

Plugin annotation


@FieldFormatter(
  id = "entity_reference_table",
  label = @Translation("Table of Fields"),
  field_types = {
    "entity_reference",
    "entity_reference_revisions"
  }
)

Hierarchy

Expanded class hierarchy of EntityReferenceTableFormatter

1 file declares its use of EntityReferenceTableFormatter
EntityReferenceTest.php in tests/src/Kernel/EntityReferenceTest.php

File

src/Plugin/Field/FieldFormatter/EntityReferenceTableFormatter.php, line 26

Namespace

Drupal\reference_table_formatter\Plugin\Field\FieldFormatter
View source 
class EntityReferenceTableFormatter extends EntityReferenceFormatterBase {

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

  /**
   * Entity display repository.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * Entity to table renderer.
   *
   * @var \Drupal\reference_table_formatter\EntityToTableRenderer
   */
  protected $tableRenderer;

  /**
   * {@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('reference_table_formatter.renderer'), $container
      ->get('entity_type.manager'), $container
      ->get('entity_display.repository'));
  }

  /**
   * Constructs a new ReferenceTableFormatter.
   *
   * @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\reference_table_formatter\EntityToTableRendererInterface $reference_renderer
   *   The entity-to-table renderer.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The Entity type manager.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityToTableRendererInterface $reference_renderer, EntityTypeManagerInterface $entity_type_manager, EntityDisplayRepositoryInterface $entity_display_repository) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->referenceRenderer = $reference_renderer;
    $this->entityTypeManager = $entity_type_manager;
    $this->entityDisplayRepository = $entity_display_repository;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'view_mode' => 'default',
      'show_entity_label' => FALSE,
      'empty_cell_value' => '',
      'hide_header' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form['view_mode'] = [
      '#title' => $this
        ->t('View Mode'),
      '#description' => $this
        ->t('Select the view mode which will control which fields are shown and the display settings of those fields.'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('view_mode'),
      '#options' => $this
        ->getConfigurableViewModes(),
    ];
    $form['show_entity_label'] = [
      '#title' => $this
        ->t('Display Entity Label'),
      '#description' => $this
        ->t('Whether the label of the target entity be displayed in the table.'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('show_entity_label'),
    ];
    $form['hide_header'] = [
      '#title' => $this
        ->t('Hide Table Header'),
      '#description' => $this
        ->t('Whether the table header be displayed.'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('hide_header'),
    ];
    $form['empty_cell_value'] = [
      '#title' => $this
        ->t('Empty Cell Value'),
      '#description' => $this
        ->t('The string which should be displayed in empty cells.'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('empty_cell_value'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $settings = $this
      ->getSettings();
    $view_modes = $this
      ->getConfigurableViewModes();
    $view_mode = $settings['view_mode'];
    $arguments = [
      '@mode' => isset($view_modes[$view_mode]) ? $view_modes[$view_mode] : $view_mode,
    ];
    $summary[] = $this
      ->t('Showing a table of rendered @mode entity fields', $arguments);
    if ($settings['show_entity_label']) {
      $summary[] = $this
        ->t('Entity label displayed');
    }
    if ($settings['hide_header']) {
      $summary[] = $this
        ->t('Table header hidden');
    }
    if ($settings['empty_cell_value']) {
      $summary[] = $this
        ->t('Empty cell value: @value', [
        '@value' => $settings['empty_cell_value'],
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    if ($entities = $this
      ->getEntitiesToView($items, $langcode)) {

      // Return an array so that field labels still work.
      return [
        $this->referenceRenderer
          ->getTable($this
          ->getFieldSetting('target_type'), $this
          ->getTargetBundleId(), $entities, $this
          ->getSettings()),
      ];
    }
    return [];
  }

  /**
   * Get the view modes which can be selected for this field formatter.
   *
   * @return string[]
   *   Array of view mode options; translated labels keyed by ID.
   */
  protected function getConfigurableViewModes() {
    return $this->entityDisplayRepository
      ->getViewModeOptions($this
      ->getFieldSetting('target_type'));
  }

  /**
   * Get the target bundle from a reference field.
   *
   * @return string
   *   The bundle that is the target of the field.
   *
   * @throws \Exception
   */
  protected function getTargetBundleId() {
    $settings = $this
      ->getFieldSettings();
    if (strpos($settings['handler'], 'default') === 0) {
      $target_entity_type = $this->entityTypeManager
        ->getDefinition($settings['target_type']);
      if (!$target_entity_type
        ->hasKey('bundle')) {
        $target_bundle = $settings['target_type'];
      }
      elseif (!empty($settings['handler_settings']['target_bundles'])) {

        // Default to the first bundle, currently only supporting a single
        // bundle.
        $target_bundle = array_values($settings['handler_settings']['target_bundles']);
        $target_bundle = array_shift($target_bundle);
      }
      else {
        throw new \Exception('Cannot render reference table for ' . $this->fieldDefinition
          ->getLabel() . ': target_bundles setting on the field should not be empty.');
      }
    }
    else {

      // Since we are only supporting rendering a single bundle, we wont know
      // what bundle we are rendering if users aren't using the default
      // selection, which is a simple configuration form.
      throw new \Exception('Using non-default reference handler with reference_table_formatter has not yet been implemented.');
    }
    return $target_bundle;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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
EntityReferenceTableFormatter::$entityDisplayRepository protected property Entity display repository.
EntityReferenceTableFormatter::$entityTypeManager protected property Entity type manager.
EntityReferenceTableFormatter::$tableRenderer protected property Entity to table renderer.
EntityReferenceTableFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
EntityReferenceTableFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
EntityReferenceTableFormatter::getConfigurableViewModes protected function Get the view modes which can be selected for this field formatter.
EntityReferenceTableFormatter::getTargetBundleId protected function Get the target bundle from a reference field.
EntityReferenceTableFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
EntityReferenceTableFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
EntityReferenceTableFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
EntityReferenceTableFormatter::__construct public function Constructs a new ReferenceTableFormatter. 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.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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. 4
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.