class FileSize

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

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

Attributes

#[FieldFormatter(id: 'file_size', label: new TranslatableMarkup('Bytes (KB, MB, ...)'), field_types: ['integer'])]
#[ViewsField("file_size")]

Hierarchy

  • class \Drupal\file\Plugin\Field\FieldFormatter\FileSize extends \Drupal\Core\Field\FormatterBase

Expanded class hierarchy of FileSize

5 string references to 'FileSize'
FileAccessControlHandler::checkFieldAccess in core/modules/file/src/FileAccessControlHandler.php
FileEntityFormatterTest::testFormatterFileSize in core/modules/file/tests/src/Kernel/Formatter/FileEntityFormatterTest.php
Tests the file_size field formatter.
FileStorage::spaceUsed in core/modules/file/src/FileStorage.php
FileViewsFieldAccessTest::testFileFields in core/modules/file/tests/src/Kernel/Views/FileViewsFieldAccessTest.php
Check access for file fields.
views.view.files.yml in core/modules/file/config/optional/views.view.files.yml
core/modules/file/config/optional/views.view.files.yml

File

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

Namespace

Drupal\file\Plugin\Field\FieldFormatter
View source 
class FileSize extends FormatterBase {
    
    /**
     * {@inheritdoc}
     */
    public function viewElements(FieldItemListInterface $items, $langcode) {
        $elements = [];
        foreach ($items as $delta => $item) {
            $elements[$delta] = [
                '#markup' => ByteSizeMarkup::create((int) $item->value),
            ];
        }
        return $elements;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
FileSize::viewElements public function 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. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Overrides ContainerFactoryPluginInterface::create 13
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 Overrides FormatterInterface::isApplicable 12
FormatterBase::prepareView public function Overrides FormatterInterface::prepareView 2
FormatterBase::settingsForm public function Overrides FormatterInterface::settingsForm 24
FormatterBase::settingsSummary public function Overrides FormatterInterface::settingsSummary 23
FormatterBase::view public function Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. 13
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
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 Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Overrides ThirdPartySettingsInterface::unsetThirdPartySetting

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