interface MediaSourceEntityConstraintsInterface in Drupal 9

Defines an interface for a media source with entity constraints.

This allows a media source to optionally add entity validation constraints for media items. To add constraints at the source field level, a media source can also implement MediaSourceFieldConstraintsInterface.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface
  • interface \Drupal\media\MediaSourceInterface
    • interface \Drupal\media\MediaSourceEntityConstraintsInterface

See also

\Drupal\media\MediaSourceInterface

\Drupal\media\MediaSourceFieldConstraintsInterface.php

\Drupal\media\MediaSourceBase

\Drupal\media\Entity\Media

2 files declare their use of MediaSourceEntityConstraintsInterface

Media.php in core/modules/media/src/Entity/Media.php

TestWithConstraints.php in core/modules/media/tests/modules/media_test_source/src/Plugin/media/Source/TestWithConstraints.php

File

core/modules/media/src/MediaSourceEntityConstraintsInterface.php, line 17

Namespace

Drupal\media

interface MediaSourceEntityConstraintsInterface extends MediaSourceInterface {

  /**
   * Gets media source-specific validation constraints for a media item.
   *
   * @return \Symfony\Component\Validator\Constraint[]
   *   An array of validation constraint definitions, keyed by constraint name.
   *   Each constraint definition can be used for instantiating
   *   \Symfony\Component\Validator\Constraint objects.
   */
  public function getEntityConstraints();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	14
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	15
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	15
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	20
MediaSourceEntityConstraintsInterface::getEntityConstraints	public	function	Gets media source-specific validation constraints for a media item.	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.	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
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	37
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2