class 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
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase- class \Drupal\media\MediaSourceBase implements \Drupal\media\MediaSourceInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Plugin\PluginBase- class \Drupal\media\Plugin\media\Source\File extends \Drupal\media\MediaSourceBase
 
 
- class \Drupal\media\MediaSourceBase implements \Drupal\media\MediaSourceInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Plugin\PluginBase
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of File
See also
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 
316 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 
- Tests 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.
File
- 
              core/modules/ media/ src/ Plugin/ media/ Source/ File.php, line 23 
Namespace
Drupal\media\Plugin\media\SourceView 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 | 
|---|---|---|---|---|---|
| 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 | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| 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. | Overrides PluginBase::__construct | 2 | 
| MediaSourceInterface::METADATA_FIELD_EMPTY | constant | Default empty value for metadata fields. | |||
| MessengerTrait::$messenger | protected | property | The messenger. | 27 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | |
| 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 | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | |
| PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | |
| PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | 
| PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
| PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
| 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. | 2 | |
| 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.
