FileSize.php

Same filename in this branch
  1. 10 core/modules/file/src/Plugin/Field/FieldFormatter/FileSize.php
Same filename and directory in other branches
  1. 9 core/modules/file/src/Plugin/Field/FieldFormatter/FileSize.php
  2. 9 core/modules/views/src/Plugin/views/field/FileSize.php
  3. 8.9.x core/modules/file/src/Plugin/Field/FieldFormatter/FileSize.php
  4. 8.9.x core/modules/views/src/Plugin/views/field/FileSize.php
  5. 11.x core/modules/file/src/Plugin/Field/FieldFormatter/FileSize.php
  6. 11.x core/modules/views/src/Plugin/views/field/FileSize.php

Namespace

Drupal\views\Plugin\views\field

File

core/modules/views/src/Plugin/views/field/FileSize.php

View source
<?php

namespace Drupal\views\Plugin\views\field;

use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\StringTranslation\ByteSizeMarkup;
use Drupal\views\Attribute\ViewsField;
use Drupal\views\ResultRow;

/**
 * Render a numeric value as a size.
 *
 * @ingroup views_field_handlers
 */
class FileSize extends FieldPluginBase {
  
  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['file_size_display'] = [
      'default' => 'formatted',
    ];
    return $options;
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['file_size_display'] = [
      '#title' => $this->t('File size display'),
      '#type' => 'select',
      '#options' => [
        'formatted' => $this->t('Formatted (in KB or MB)'),
        'bytes' => $this->t('Raw bytes'),
      ],
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function render(ResultRow $values) {
    $value = $this->getValue($values);
    if ($value) {
      switch ($this->options['file_size_display']) {
        case 'bytes':
          return $value;
        case 'formatted':
        default:
          return ByteSizeMarkup::create((int) $value);
      }
    }
    else {
      return '';
    }
  }

}

Classes

Title Deprecated Summary
FileSize Render a numeric value as a size.

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