MediaSourceFieldConstraintsInterface
interface MediaSourceFieldConstraintsInterface implements MediaSourceInterface (View source)
Defines an interface for a media source with source field constraints.
This allows a media source to optionally add source field validation constraints for media items. To add constraints at the entity level, a media source can also implement MediaSourceEntityConstraintsInterface.
Methods
Gets the definition of the plugin implementation.
Sets the configuration for this plugin instance.
Calculates dependencies for the configured plugin.
Gets a list of metadata attributes provided by this plugin.
Gets the value for a metadata attribute for a given media item.
Get the source field definition for a media type.
Prepares the media type fields for this source in the view display.
Prepares the media type fields for this source in the form display.
Gets media source-specific validation constraints for a source field.
Details
string
getPluginId()
Gets the plugin_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
array
getConfiguration()
Gets this plugin's configuration.
setConfiguration(array $configuration)
Sets the configuration for this plugin instance.
array
defaultConfiguration()
Gets default configuration for this plugin.
array
calculateDependencies()
Calculates dependencies for the configured plugin.
Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.
array
buildConfigurationForm(array $form, FormStateInterface $form_state)
Form constructor.
Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and
array_parents, see \Drupal\Core\Render\Element\FormElement.
validateConfigurationForm(array $form, FormStateInterface $form_state)
Form validation handler.
submitConfigurationForm(array $form, FormStateInterface $form_state)
Form submission handler.
array
getMetadataAttributes()
Gets a list of metadata attributes provided by this plugin.
Most media sources have associated metadata, describing attributes such as:
- dimensions
- duration
- encoding
- date
- location
- permalink
- licensing information
- ...
This method should list all metadata attributes that a media source MAY offer. In other words: it is possible that a particular media item does not contain a certain attribute. For example: an oEmbed media source can contain both video and images. Images don't have a duration, but videos do.
(The term 'attributes' was chosen because it cannot be confused with 'fields' and 'properties', both of which are concepts in Drupal's Entity Field API.)
mixed|null
getMetadata(MediaInterface $media, string $attribute_name)
Gets the value for a metadata attribute for a given media item.
FieldDefinitionInterface|null
getSourceFieldDefinition(MediaTypeInterface $type)
Get the source field definition for a media type.
FieldConfigInterface
createSourceField(MediaTypeInterface $type)
Creates the source field definition for a type.
prepareViewDisplay(MediaTypeInterface $type, EntityViewDisplayInterface $display)
Prepares the media type fields for this source in the view display.
This method should normally call \Drupal\Core\Entity\Display\EntityDisplayInterface::setComponent() or \Drupal\Core\Entity\Display\EntityDisplayInterface::removeComponent() to configure the media type fields in the view display.
prepareFormDisplay(MediaTypeInterface $type, EntityFormDisplayInterface $display)
Prepares the media type fields for this source in the form display.
This method should normally call \Drupal\Core\Entity\Display\EntityDisplayInterface::setComponent() or \Drupal\Core\Entity\Display\EntityDisplayInterface::removeComponent() to configure the media type fields in the form display.
mixed
getSourceFieldValue(MediaInterface $media)
Get the primary value stored in the source field.
Constraint[]
getSourceFieldConstraints()
Gets media source-specific validation constraints for a source field.