class File

Same name in this branch
  1. 8.9.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
  2. 8.9.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
  3. 8.9.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
  4. 8.9.x core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
  5. 8.9.x core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
  6. 8.9.x core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
Same name in other branches
  1. 9 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
  2. 9 core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
  3. 9 core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
  4. 9 core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
  5. 9 core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
  6. 9 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
  7. 9 core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
  8. 10 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
  9. 10 core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
  10. 10 core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
  11. 10 core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
  12. 10 core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
  13. 10 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
  14. 10 core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
  15. 11.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
  16. 11.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
  17. 11.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
  18. 11.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
  19. 11.x core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
  20. 11.x core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
  21. 11.x core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File

File entity media source.

Plugin annotation


@MediaSource(
  id = "file",
  label = @Translation("File"),
  description = @Translation("Use local files for reusable media."),
  allowed_field_types = {"file"},
  default_thumbnail_filename = "generic.png"
)

Hierarchy

Expanded class hierarchy of File

See also

\Drupal\file\FileInterface

2 files declare their use of File
MediaLibraryDisplayModeTest.php in core/modules/media_library/tests/src/Functional/MediaLibraryDisplayModeTest.php
MediaSourceFileTest.php in core/modules/media/tests/src/FunctionalJavascript/MediaSourceFileTest.php
323 string references to 'File'
AccessTest::setUp in core/modules/file/tests/src/Kernel/AccessTest.php
AjaxFileManagedMultipleTest::testMultipleFilesUpload in core/modules/file/tests/src/FunctionalJavascript/AjaxFileManagedMultipleTest.php
Test if managed file form element works well with multiple files upload.
AnnotatedClassDiscoveryTest::provideBadAnnotations in core/tests/Drupal/Tests/Component/Plugin/Discovery/AnnotatedClassDiscoveryTest.php
All the Drupal documentation standards tags.
AssetResolver::getCssAssets in core/lib/Drupal/Core/Asset/AssetResolver.php
Returns the CSS assets for the current response's libraries.
AssetResolver::getJsAssets in core/lib/Drupal/Core/Asset/AssetResolver.php
Returns the JavaScript assets for the current response's libraries.

... See full list

File

core/modules/media/src/Plugin/media/Source/File.php, line 23

Namespace

Drupal\media\Plugin\media\Source
View source
class File extends MediaSourceBase {
    
    /**
     * Key for "Name" metadata attribute.
     *
     * @var string
     */
    const METADATA_ATTRIBUTE_NAME = 'name';
    
    /**
     * Key for "MIME type" metadata attribute.
     *
     * @var string
     */
    const METADATA_ATTRIBUTE_MIME = 'mimetype';
    
    /**
     * Key for "File size" metadata attribute.
     *
     * @var string
     */
    const METADATA_ATTRIBUTE_SIZE = 'filesize';
    
    /**
     * {@inheritdoc}
     */
    public function getMetadataAttributes() {
        return [
            static::METADATA_ATTRIBUTE_NAME => $this->t('Name'),
            static::METADATA_ATTRIBUTE_MIME => $this->t('MIME type'),
            static::METADATA_ATTRIBUTE_SIZE => $this->t('File size'),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getMetadata(MediaInterface $media, $attribute_name) {
        
        /** @var \Drupal\file\FileInterface $file */
        $file = $media->get($this->configuration['source_field'])->entity;
        // If the source field is not required, it may be empty.
        if (!$file) {
            return parent::getMetadata($media, $attribute_name);
        }
        switch ($attribute_name) {
            case static::METADATA_ATTRIBUTE_NAME:
            case 'default_name':
                return $file->getFilename();
            case static::METADATA_ATTRIBUTE_MIME:
                return $file->getMimeType();
            case static::METADATA_ATTRIBUTE_SIZE:
                return $file->getSize();
            case 'thumbnail_uri':
                return $this->getThumbnail($file) ?: parent::getMetadata($media, $attribute_name);
            default:
                return parent::getMetadata($media, $attribute_name);
        }
    }
    
    /**
     * Gets the thumbnail image URI based on a file entity.
     *
     * @param \Drupal\file\FileInterface $file
     *   A file entity.
     *
     * @return string
     *   File URI of the thumbnail image or NULL if there is no specific icon.
     */
    protected function getThumbnail(FileInterface $file) {
        $icon_base = $this->configFactory
            ->get('media.settings')
            ->get('icon_base_uri');
        // We try to automatically use the most specific icon present in the
        // $icon_base directory, based on the MIME type. For instance, if an
        // icon file named "pdf.png" is present, it will be used if the file
        // matches this MIME type.
        $mimetype = $file->getMimeType();
        $mimetype = explode('/', $mimetype);
        $icon_names = [
            $mimetype[0] . '--' . $mimetype[1],
            $mimetype[1],
            $mimetype[0],
        ];
        foreach ($icon_names as $icon_name) {
            $thumbnail = $icon_base . '/' . $icon_name . '.png';
            if (is_file($thumbnail)) {
                return $thumbnail;
            }
        }
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function createSourceField(MediaTypeInterface $type) {
        return parent::createSourceField($type)->set('settings', [
            'file_extensions' => 'txt doc docx pdf',
        ]);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
File::createSourceField public function Creates the source field definition for a type. Overrides MediaSourceBase::createSourceField 3
File::getMetadata public function Gets the value for a metadata attribute for a given media item. Overrides MediaSourceBase::getMetadata 1
File::getMetadataAttributes public function Gets a list of metadata attributes provided by this plugin. Overrides MediaSourceInterface::getMetadataAttributes 1
File::getThumbnail protected function Gets the thumbnail image URI based on a file entity.
File::METADATA_ATTRIBUTE_MIME constant Key for "MIME type" metadata attribute.
File::METADATA_ATTRIBUTE_NAME constant Key for "Name" metadata attribute.
File::METADATA_ATTRIBUTE_SIZE constant Key for "File size" metadata attribute.
MediaSourceBase::$configFactory protected property The config factory service.
MediaSourceBase::$entityFieldManager protected property The entity field manager service.
MediaSourceBase::$entityTypeManager protected property The entity type manager service.
MediaSourceBase::$fieldTypeManager protected property The field type plugin manager service.
MediaSourceBase::$label protected property Plugin label.
MediaSourceBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
MediaSourceBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
MediaSourceBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 2
MediaSourceBase::createSourceFieldStorage protected function Creates the source field storage definition.
MediaSourceBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 2
MediaSourceBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
MediaSourceBase::getSourceFieldDefinition public function Get the source field definition for a media type. Overrides MediaSourceInterface::getSourceFieldDefinition
MediaSourceBase::getSourceFieldName protected function Determine the name of the source field. 2
MediaSourceBase::getSourceFieldOptions protected function Get the source field options for the media type form.
MediaSourceBase::getSourceFieldStorage protected function Returns the source field storage definition.
MediaSourceBase::getSourceFieldValue public function Get the primary value stored in the source field. Overrides MediaSourceInterface::getSourceFieldValue
MediaSourceBase::prepareFormDisplay public function Prepares the media type fields for this source in the form display. Overrides MediaSourceInterface::prepareFormDisplay 3
MediaSourceBase::prepareViewDisplay public function Prepares the media type fields for this source in the view display. Overrides MediaSourceInterface::prepareViewDisplay 6
MediaSourceBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
MediaSourceBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 1
MediaSourceBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
MediaSourceBase::__construct public function Constructs a new class instance. 2
MediaSourceInterface::METADATA_FIELD_EMPTY constant Default empty value for metadata fields.
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

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