interface OEmbedInterface

Defines additional functionality for source plugins that use oEmbed.

Hierarchy

interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Plugin\PluginFormInterface
- interface \Drupal\media\MediaSourceInterface extends \Drupal\Component\Plugin\PluginInspectionInterface \Drupal\Component\Plugin\ConfigurableInterface \Drupal\Component\Plugin\DependentPluginInterface \Drupal\Core\Plugin\PluginFormInterface
  - interface \Drupal\media\MediaSourceFieldConstraintsInterface extends \Drupal\media\MediaSourceInterface
    - interface \Drupal\media\Plugin\media\Source\OEmbedInterface extends \Drupal\media\MediaSourceFieldConstraintsInterface

Expanded class hierarchy of OEmbedInterface

All classes that implement OEmbedInterface

5 files declare their use of OEmbedInterface

media.module in core/modules/media/media.module
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
OEmbedWidget.php in core/modules/media/src/Plugin/Field/FieldWidget/OEmbedWidget.php

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 Sort descending	Modifiers	Object type	Summary	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	10
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	10
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	10
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	18
MediaSourceFieldConstraintsInterface::getSourceFieldConstraints	public	function	Gets media source-specific validation constraints for a source field.	1
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.	2
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.	20
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	20
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	15
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	5
PluginInspectionInterface::getPluginId	public	function	Gets the plugin ID of the plugin instance.	2