class AudioFile
Same name in other branches
- 9 core/modules/media/src/Plugin/media/Source/AudioFile.php \Drupal\media\Plugin\media\Source\AudioFile
- 8.9.x core/modules/media/src/Plugin/media/Source/AudioFile.php \Drupal\media\Plugin\media\Source\AudioFile
- 11.x core/modules/media/src/Plugin/media/Source/AudioFile.php \Drupal\media\Plugin\media\Source\AudioFile
Media source wrapping around an audio file.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\media\MediaSourceBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\media\MediaSourceInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of AudioFile
See also
File
-
core/
modules/ media/ src/ Plugin/ media/ Source/ AudioFile.php, line 15
Namespace
Drupal\media\Plugin\media\SourceView source
class AudioFile extends File {
/**
* {@inheritdoc}
*/
public function createSourceField(MediaTypeInterface $type) {
return parent::createSourceField($type)->set('settings', [
'file_extensions' => 'mp3 wav aac',
]);
}
/**
* {@inheritdoc}
*/
public function prepareViewDisplay(MediaTypeInterface $type, EntityViewDisplayInterface $display) {
$display->setComponent($this->getSourceFieldDefinition($type)
->getName(), [
'type' => 'file_audio',
'label' => 'visually_hidden',
]);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
AudioFile::createSourceField | public | function | Creates the source field definition for a type. | Overrides File::createSourceField | |
AudioFile::prepareViewDisplay | public | function | Prepares the media type fields for this source in the view display. | Overrides MediaSourceBase::prepareViewDisplay | |
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::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.