TableFormatter.php

Same filename in other branches
  1. 9 core/modules/file/src/Plugin/Field/FieldFormatter/TableFormatter.php
  2. 8.9.x core/modules/file/src/Plugin/Field/FieldFormatter/TableFormatter.php
  3. 11.x core/modules/file/src/Plugin/Field/FieldFormatter/TableFormatter.php

Namespace

Drupal\file\Plugin\Field\FieldFormatter

File

core/modules/file/src/Plugin/Field/FieldFormatter/TableFormatter.php

View source
<?php

namespace Drupal\file\Plugin\Field\FieldFormatter;

use Drupal\Core\Field\Attribute\FieldFormatter;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\StringTranslation\ByteSizeMarkup;
use Drupal\Core\StringTranslation\TranslatableMarkup;

/**
 * Plugin implementation of the 'file_table' formatter.
 */
class TableFormatter extends DescriptionAwareFileFormatterBase {
    
    /**
     * {@inheritdoc}
     */
    public function viewElements(FieldItemListInterface $items, $langcode) {
        $elements = [];
        if ($files = $this->getEntitiesToView($items, $langcode)) {
            $header = [
                $this->t('Attachment'),
                $this->t('Size'),
            ];
            $rows = [];
            foreach ($files as $file) {
                $item = $file->_referringItem;
                $rows[] = [
                    [
                        'data' => [
                            '#theme' => 'file_link',
                            '#file' => $file,
                            '#description' => $this->getSetting('use_description_as_link_text') ? $item->description : NULL,
                            '#cache' => [
                                'tags' => $file->getCacheTags(),
                            ],
                        ],
                    ],
                    [
                        'data' => $file->getSize() !== NULL ? ByteSizeMarkup::create($file->getSize()) : $this->t('Unknown'),
                    ],
                ];
            }
            $elements[0] = [];
            if (!empty($rows)) {
                $elements[0] = [
                    '#theme' => 'table__file_formatter_table',
                    '#header' => $header,
                    '#rows' => $rows,
                ];
            }
        }
        return $elements;
    }

}

Classes

Title Deprecated Summary
TableFormatter Plugin implementation of the 'file_table' formatter.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.