public function TablefieldFormatter::viewElements in TableField 8.2

Builds a renderable array for a field value.

Parameters

\Drupal\Core\Field\FieldItemListInterface $items: The field values to be rendered.

string $langcode: The language that should be used to render the field.

Return value

array A renderable array for $items, as an array of child elements keyed by consecutive numeric indexes starting from 0.

Overrides FormatterInterface::viewElements

File

src/Plugin/Field/FieldFormatter/TablefieldFormatter.php, line 129

Class

TablefieldFormatter

Plugin implementation of the default Tablefield formatter.

Namespace

Drupal\tablefield\Plugin\Field\FieldFormatter

Code

public function viewElements(FieldItemListInterface $items, $langcode = NULL) {
  $field = $items
    ->getFieldDefinition();
  $field_name = $field
    ->getName();
  $field_settings = $field
    ->getSettings();
  $entity = $items
    ->getEntity();
  $entity_type = $entity
    ->getEntityTypeId();
  $entity_id = $entity
    ->id();
  $row_header = $this
    ->getSetting('row_header');
  $column_header = $this
    ->getSetting('column_header');
  $elements = [];
  $header = [];
  foreach ($items as $delta => $table) {
    if (!empty($table->value)) {

      // Tablefield::rationalizeTable($table->value);.
      $tabledata = $table->value;
      $caption = $tabledata['caption'];
      unset($tabledata['caption']);

      // Run the table through input filters.
      foreach ($tabledata as $row_key => $row) {
        foreach ($row as $col_key => $cell) {
          $tabledata[$row_key][$col_key] = [
            'data' => empty($table->format) ? $cell : check_markup($cell, $table->format),
            'class' => [
              'row_' . $row_key,
              'col_' . $col_key,
            ],
          ];
        }
      }
      if ($row_header) {

        // Pull the header for theming.
        $header_data = array_shift($tabledata);

        // Check for an empty header, if so we don't want to theme it.
        $has_header = FALSE;
        foreach ($header_data as $cell) {
          if (strlen($cell['data']) > 0) {
            $has_header = TRUE;
            break;
          }
        }
        if ($has_header) {
          $header = $header_data;
        }
      }
      if ($column_header) {
        foreach ($tabledata as $row_key => $row) {
          if (strlen($tabledata[$row_key][0]['data']) > 0) {
            $tabledata[$row_key][0]['header'] = TRUE;
          }
        }
      }
      $render_array = [];

      // If the user has access to the csv export option, display it now.
      if ($field_settings['export'] && $entity_id && $this->currentUser
        ->hasPermission('export tablefield')) {
        $route_params = [
          'entity_type' => $entity_type,
          'entity' => $entity_id,
          'field_name' => $field_name,
          'langcode' => $items
            ->getLangcode(),
          'delta' => $delta,
        ];
        $url = Url::fromRoute('tablefield.export', $route_params);
        $render_array['export'] = [
          '#type' => 'container',
          '#attributes' => [
            'id' => 'tablefield-export-link-' . $delta,
            'class' => 'tablefield-export-link',
          ],
        ];
        $render_array['export']['link'] = [
          '#type' => 'link',
          '#title' => $this
            ->t('Export Table Data'),
          '#url' => $url,
        ];
      }
      $render_array['tablefield'] = [
        '#type' => 'table',
        '#header' => $header,
        '#rows' => $tabledata,
        '#attributes' => [
          'id' => 'tablefield-' . $entity_type . '-' . $entity_id . '-' . $field_name . '-' . $delta,
          'class' => [
            'tablefield',
          ],
        ],
        '#caption' => $caption,
        '#prefix' => '<div id="tablefield-wrapper-' . $entity_type . '-' . $entity_id . '-' . $field_name . '-' . $delta . '" class="tablefield-wrapper">',
        '#suffix' => '</div>',
        '#responsive' => FALSE,
      ];

      // Extend render array if responsive_tables_filter module is enabled.
      if ($this->ModuleHandler
        ->moduleExists('responsive_tables_filter')) {
        array_push($render_array['tablefield']['#attributes']['class'], 'tablesaw', 'tablesaw-stack');
        $render_array['tablefield']['#attributes']['data-tablesaw-mode'] = 'stack';
        $render_array['tablefield']['#attached'] = [
          'library' => [
            'responsive_tables_filter/tablesaw-filter',
          ],
        ];
      }
      $elements[$delta] = $render_array;
    }
  }
  return $elements;
}