class TestWithConstraints
Provides generic media type.
Plugin annotation
@MediaSource(
id = "test_constraints",
label = @Translation("Test source with constraints"),
description = @Translation("Test media source that provides constraints."),
allowed_field_types = {"string_long"},
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\media\MediaSourceBase implements \Drupal\media\MediaSourceInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\media_test_source\Plugin\media\Source\Test extends \Drupal\media\MediaSourceBase
- class \Drupal\media_test_source\Plugin\media\Source\TestWithConstraints implements \Drupal\media\MediaSourceEntityConstraintsInterface, \Drupal\media\MediaSourceFieldConstraintsInterface extends \Drupal\media_test_source\Plugin\media\Source\Test
- class \Drupal\media_test_source\Plugin\media\Source\Test extends \Drupal\media\MediaSourceBase
- class \Drupal\media\MediaSourceBase implements \Drupal\media\MediaSourceInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of TestWithConstraints
File
-
core/
modules/ media/ tests/ modules/ media_test_source/ src/ Plugin/ media/ Source/ TestWithConstraints.php, line 18
Namespace
Drupal\media_test_source\Plugin\media\SourceView source
class TestWithConstraints extends Test implements MediaSourceEntityConstraintsInterface, MediaSourceFieldConstraintsInterface {
/**
* {@inheritdoc}
*/
public function getEntityConstraints() {
return \Drupal::state()->get('media_source_test_entity_constraints', []);
}
/**
* {@inheritdoc}
*/
public function getSourceFieldConstraints() {
return \Drupal::state()->get('media_source_test_field_constraints', []);
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
| DependencySerializationTrait::__sleep | public | function | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| 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::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::createSourceField | public | function | Creates the source field definition for a type. | Overrides MediaSourceInterface::createSourceField | 2 |
| MediaSourceBase::createSourceFieldStorage | protected | function | Creates the source field storage definition. | ||
| 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::prepareViewDisplay | public | function | Prepares the media type fields for this source in the view display. | Overrides MediaSourceInterface::prepareViewDisplay | 6 |
| 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. | Overrides PluginBase::__construct | 2 |
| MediaSourceInterface::METADATA_FIELD_EMPTY | constant | Default empty value for metadata fields. | |||
| MessengerTrait::$messenger | protected | property | The messenger. | 27 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | |
| PluginBase::$pluginId | protected | property | The plugin_id. | ||
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |||
| PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | |
| PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | |
| PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
| PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | ||
| Test::buildConfigurationForm | public | function | Form constructor. | Overrides MediaSourceBase::buildConfigurationForm | |
| Test::defaultConfiguration | public | function | Gets default configuration for this plugin. | Overrides MediaSourceBase::defaultConfiguration | |
| Test::getMetadata | public | function | Gets the value for a metadata attribute for a given media item. | Overrides MediaSourceBase::getMetadata | 1 |
| Test::getMetadataAttributes | public | function | Gets a list of metadata attributes provided by this plugin. | Overrides MediaSourceInterface::getMetadataAttributes | |
| Test::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginBase::getPluginDefinition | |
| TestWithConstraints::getEntityConstraints | public | function | Gets media source-specific validation constraints for a media item. | Overrides MediaSourceEntityConstraintsInterface::getEntityConstraints | |
| TestWithConstraints::getSourceFieldConstraints | public | function | Gets media source-specific validation constraints for a source field. | Overrides MediaSourceFieldConstraintsInterface::getSourceFieldConstraints |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.