class FileSize

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

Formatter that shows the file size in a human readable way.

Plugin annotation


@FieldFormatter(
  id = "file_size",
  label = @Translation("File size"),
  field_types = {
    "integer"
  }
)

Hierarchy

Expanded class hierarchy of FileSize

6 string references to 'FileSize'
FileAccessControlHandler::checkFieldAccess in core/modules/file/src/FileAccessControlHandler.php
Default field access as determined by this access control handler.
FileEntityFormatterTest::testFormatterFileSize in core/modules/file/tests/src/Kernel/Formatter/FileEntityFormatterTest.php
Tests the file_size field formatter.
FileSize::isApplicable in core/modules/file/src/Plugin/Field/FieldFormatter/FileSize.php
Returns if the formatter can be used for the provided field.
FileStorage::spaceUsed in core/modules/file/src/FileStorage.php
Determines total disk space used by a single user or the whole filesystem.
FileViewsFieldAccessTest::testFileFields in core/modules/file/tests/src/Kernel/Views/FileViewsFieldAccessTest.php
Check access for file fields.

... See full list

File

core/modules/file/src/Plugin/Field/FieldFormatter/FileSize.php, line 20

Namespace

Drupal\file\Plugin\Field\FieldFormatter
View source
class FileSize extends FormatterBase {
  
  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    return parent::isApplicable($field_definition) && $field_definition->getName() === 'filesize';
  }
  
  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {
      $elements[$delta] = [
        '#markup' => format_size($item->value),
      ];
    }
    return $elements;
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange]
FileSize::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
FileSize::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings.
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function 3
FormatterBase::create public static function 3
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::prepareView public function 1
FormatterBase::prepareView public function 1
FormatterBase::settingsForm public function 12
FormatterBase::settingsForm public function 12
FormatterBase::settingsSummary public function 10
FormatterBase::settingsSummary public function 10
FormatterBase::view public function
FormatterBase::__construct public function Constructs a FormatterBase object. 3
FormatterBase::__construct public function Constructs a FormatterBase object. 3
MessengerTrait::$messenger protected property The messenger. 7
MessengerTrait::$messenger protected property The messenger. 7
MessengerTrait::messenger public function Gets the messenger. 7
MessengerTrait::messenger public function Gets the messenger. 7
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
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
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 1
PluginBase::getPluginDefinition public function 1
PluginBase::getPluginId public function
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 2
PluginSettingsBase::calculateDependencies public function 2
PluginSettingsBase::defaultSettings public static function 18
PluginSettingsBase::defaultSettings public static function 18
PluginSettingsBase::getSetting public function
PluginSettingsBase::getSettings public function
PluginSettingsBase::getThirdPartyProviders public function
PluginSettingsBase::getThirdPartySetting public function
PluginSettingsBase::getThirdPartySettings public function
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function 1
PluginSettingsBase::onDependencyRemoval public function 1
PluginSettingsBase::setSetting public function
PluginSettingsBase::setSettings public function
PluginSettingsBase::setThirdPartySetting public function
PluginSettingsBase::unsetThirdPartySetting public function
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

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