You are here

Home » API reference » Double Field 4.x » Table.php

class Table in Double Field 4.x

Same name and namespace in other branches
  1. 8.3 src/Plugin/Field/FieldFormatter/Table.php \Drupal\double_field\Plugin\Field\FieldFormatter\Table

Plugin implementations for 'table' formatter.

Plugin annotation


@FieldFormatter(
  id = "double_field_table",
  label = @Translation("Table"),
  field_types = {"double_field"}
)

Hierarchy

Expanded class hierarchy of Table

File

src/Plugin/Field/FieldFormatter/Table.php, line 17

Namespace

Drupal\double_field\Plugin\Field\FieldFormatter
View source 
class Table extends Base {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() : array {
    return [
      'number_column' => FALSE,
      'number_column_label' => '№',
      'first_column_label' => '',
      'second_column_label' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) : array {
    $settings = $this
      ->getSettings();
    $element['number_column'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable row number column'),
      '#default_value' => $settings['number_column'],
      '#attributes' => [
        'class' => [
          'js-double-field-number-column',
        ],
      ],
    ];
    $element['number_column_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Number column label'),
      '#size' => 30,
      '#default_value' => $settings['number_column_label'],
      '#states' => [
        'visible' => [
          '.js-double-field-number-column' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    foreach ([
      'first',
      'second',
    ] as $subfield) {
      $element[$subfield . '_column_label'] = [
        '#type' => 'textfield',
        '#title' => $subfield == 'first' ? $this
          ->t('First column label') : $this
          ->t('Second column label'),
        '#size' => 30,
        '#default_value' => $settings[$subfield . '_column_label'] ?: $this
          ->getFieldSetting($subfield)['label'],
      ];
    }
    return $element + parent::settingsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() : array {
    $settings = $this
      ->getSettings();
    $summary[] = $this
      ->t('Enable row number column: @number_column', [
      '@number_column' => $settings['number_column'] ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    if ($settings['number_column']) {
      $summary[] = $this
        ->t('Number column label: @number_column_label', [
        '@number_column_label' => $settings['number_column_label'],
      ]);
    }
    if ($settings['first_column_label'] != '') {
      $summary[] = $this
        ->t('First column label: @first_column_label', [
        '@first_column_label' => $settings['first_column_label'],
      ]);
    }
    if ($settings['second_column_label'] != '') {
      $summary[] = $this
        ->t('Second column label: @second_column_label', [
        '@second_column_label' => $settings['second_column_label'],
      ]);
    }
    return array_merge($summary, parent::settingsSummary());
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) : array {
    $settings = $this
      ->getSettings();
    $table = [
      '#type' => 'table',
    ];

    // No other way to pass context to the theme.
    // @see double_field_theme_suggestions_table_alter()
    $table['#attributes']['double-field--field-name'] = $items
      ->getName();
    $table['#attributes']['class'][] = 'double-field-table';
    if ($settings['first_column_label'] || $settings['second_column_label']) {
      if ($settings['number_column']) {
        $header[] = $settings['number_column_label'];
      }
      $header[] = $settings['first_column_label'];
      $header[] = $settings['second_column_label'];
      $table['#header'] = $header;
    }
    $field_name = $items
      ->getName();
    foreach ($items as $delta => $item) {
      $row = [];
      if ($settings['number_column']) {
        $row[]['#markup'] = $delta + 1;
      }
      foreach ([
        'first',
        'second',
      ] as $subfield) {
        if ($settings[$subfield]['hidden']) {
          $row[]['#markup'] = '';
        }
        else {
          $row[] = [
            '#theme' => 'double_field_subfield',
            '#settings' => $settings,
            '#subfield' => $item->{$subfield},
            '#index' => $subfield,
            '#field_name' => $field_name,
          ];
        }
      }
      $table[$delta] = $row;
    }
    $element[0] = $table;
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Base::$linkTypes protected static property Subfield types that can be rendered as a link.
Base::getDateFormatter protected static function Returns date formatter.
Base::numberFormat protected function Formats a number.
Base::prepareItems protected function Prepare field items.
Base::view public function Builds a renderable array for a fully themed field. Overrides FormatterBase::view
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
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 12
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
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 12
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.
Table::defaultSettings public static function Defines the default settings for this plugin. Overrides Base::defaultSettings
Table::settingsForm public function Returns a form to configure settings for the formatter. Overrides Base::settingsForm
Table::settingsSummary public function Returns a short summary for the current formatter settings. Overrides Base::settingsSummary
Table::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements