class Test
Provides test media source.
Plugin annotation
@MediaSource(
  id = "test",
  label = @Translation("Test source"),
  description = @Translation("Test media source."),
  allowed_field_types = {"string"},
)
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\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 Test
728 string references to 'Test'
- AccessAwareRouterTest::setUp in core/tests/ Drupal/ Tests/ Core/ Routing/ AccessAwareRouterTest.php 
- ActiveLinkResponseFilterTest::providerTestSetLinkActiveClass in core/tests/ Drupal/ Tests/ Core/ EventSubscriber/ ActiveLinkResponseFilterTest.php 
- Provides test data for testSetLinkActiveClass().
- ActiveWorkspaceUpdateTest::testActiveWorkspaceDuringUpdate in core/modules/ workspaces/ tests/ src/ Functional/ UpdateSystem/ ActiveWorkspaceUpdateTest.php 
- Tests that there is no active workspace during database updates.
- AjaxTestController::render in core/modules/ system/ tests/ modules/ ajax_test/ src/ Controller/ AjaxTestController.php 
- Returns a render array that will be rendered by AjaxRenderer.
- ajax_test.libraries.yml in core/modules/ system/ tests/ modules/ ajax_test/ ajax_test.libraries.yml 
- core/modules/system/tests/modules/ajax_test/ajax_test.libraries.yml
File
- 
              core/modules/ media/ tests/ modules/ media_test_source/ src/ Plugin/ media/ Source/ Test.php, line 20 
Namespace
Drupal\media_test_source\Plugin\media\SourceView source
class Test extends MediaSourceBase {
  
  /**
   * {@inheritdoc}
   */
  public function getMetadataAttributes() {
    // The metadata attributes are kept in state storage. This allows tests to
    // change the metadata attributes and makes it easier to test different
    // variations.
    $attributes = \Drupal::state()->get('media_source_test_attributes', [
      'attribute_1' => [
        'label' => $this->t('Attribute 1'),
        'value' => 'Value 1',
      ],
      'attribute_2' => [
        'label' => $this->t('Attribute 2'),
        'value' => 'Value 1',
      ],
    ]);
    return array_map(function ($item) {
      return $item['label'];
    }, $attributes);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getMetadata(MediaInterface $media, $attribute_name) {
    $attributes = \Drupal::state()->get('media_source_test_attributes', [
      'attribute_1' => [
        'label' => $this->t('Attribute 1'),
        'value' => 'Value 1',
      ],
      'attribute_2' => [
        'label' => $this->t('Attribute 2'),
        'value' => 'Value 1',
      ],
    ]);
    if (in_array($attribute_name, array_keys($attributes))) {
      return $attributes[$attribute_name]['value'];
    }
    return parent::getMetadata($media, $attribute_name);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getPluginDefinition() {
    return NestedArray::mergeDeep(parent::getPluginDefinition(), \Drupal::state()->get('media_source_test_definition', []));
  }
  
  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'test_config_value' => 'This is default value.',
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['test_config_value'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Test config value'),
      '#default_value' => $this->configuration['test_config_value'],
    ];
    return $form;
  }
}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 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
