interface OEmbedInterface

Same name and namespace in other branches
  1. 9 core/modules/media/src/Plugin/media/Source/OEmbedInterface.php \Drupal\media\Plugin\media\Source\OEmbedInterface
  2. 8.9.x core/modules/media/src/Plugin/media/Source/OEmbedInterface.php \Drupal\media\Plugin\media\Source\OEmbedInterface
  3. 10 core/modules/media/src/Plugin/media/Source/OEmbedInterface.php \Drupal\media\Plugin\media\Source\OEmbedInterface

Defines additional functionality for source plugins that use oEmbed.

Hierarchy

Expanded class hierarchy of OEmbedInterface

All classes that implement OEmbedInterface

6 files declare their use of OEmbedInterface
media.install in core/modules/media/media.install
Install, uninstall and update hooks for Media module.
media.module in core/modules/media/media.module
Provides media items.
OEmbedForm.php in core/modules/media_library/src/Form/OEmbedForm.php
OEmbedFormatter.php in core/modules/media/src/Plugin/Field/FieldFormatter/OEmbedFormatter.php
OEmbedResourceConstraintValidator.php in core/modules/media/src/Plugin/Validation/Constraint/OEmbedResourceConstraintValidator.php

... See full list

File

core/modules/media/src/Plugin/media/Source/OEmbedInterface.php, line 10

Namespace

Drupal\media\Plugin\media\Source
View source 
interface OEmbedInterface extends MediaSourceFieldConstraintsInterface {
    
    /**
     * Returns the oEmbed provider names.
     *
     * The allowed providers can be configured by the user. If it is not
     * configured, all providers supported by the plugin are returned.
     *
     * @return string[]
     *   A list of oEmbed provider names.
     */
    public function getProviders();

}

Members

Title Modifiers Object type Summary Overrides
ConfigurableInterface::defaultConfiguration public function Gets default configuration for this plugin. 13
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 13
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 13
DependentPluginInterface::calculateDependencies public function Calculates dependencies for the configured plugin. 19
MediaSourceFieldConstraintsInterface::getSourceFieldConstraints public function Gets media source-specific validation constraints for a source field. 2
MediaSourceInterface::createSourceField public function Creates the source field definition for a type. 1
MediaSourceInterface::getMetadata public function Gets the value for a metadata attribute for a given media item. 1
MediaSourceInterface::getMetadataAttributes public function Gets a list of metadata attributes provided by this plugin. 3
MediaSourceInterface::getSourceFieldDefinition public function Get the source field definition for a media type. 1
MediaSourceInterface::getSourceFieldValue public function Get the primary value stored in the source field. 1
MediaSourceInterface::METADATA_FIELD_EMPTY constant Default empty value for metadata fields.
MediaSourceInterface::prepareFormDisplay public function Prepares the media type fields for this source in the form display. 1
MediaSourceInterface::prepareViewDisplay public function Prepares the media type fields for this source in the view display. 1
OEmbedInterface::getProviders public function Returns the oEmbed provider names. 1
PluginFormInterface::buildConfigurationForm public function Form constructor. 31
PluginFormInterface::submitConfigurationForm public function Form submission handler. 29
PluginFormInterface::validateConfigurationForm public function Form validation handler. 16
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.