class TestDifferentDisplays

Same name in other branches
  1. 9 core/modules/media/tests/modules/media_test_source/src/Plugin/media/Source/TestDifferentDisplays.php \Drupal\media_test_source\Plugin\media\Source\TestDifferentDisplays
  2. 10 core/modules/media/tests/modules/media_test_source/src/Plugin/media/Source/TestDifferentDisplays.php \Drupal\media_test_source\Plugin\media\Source\TestDifferentDisplays
  3. 11.x core/modules/media/tests/modules/media_test_source/src/Plugin/media/Source/TestDifferentDisplays.php \Drupal\media_test_source\Plugin\media\Source\TestDifferentDisplays

Provides test media source.

Plugin annotation


@MediaSource(
  id = "test_different_displays",
  label = @Translation("Test source with different displays"),
  description = @Translation("Test source with different displays."),
  allowed_field_types = {"entity_reference"},
)

Hierarchy

Expanded class hierarchy of TestDifferentDisplays

File

core/modules/media/tests/modules/media_test_source/src/Plugin/media/Source/TestDifferentDisplays.php, line 19

Namespace

Drupal\media_test_source\Plugin\media\Source
View source 
class TestDifferentDisplays extends Test {
    
    /**
     * {@inheritdoc}
     */
    public function prepareViewDisplay(MediaTypeInterface $type, EntityViewDisplayInterface $display) {
        parent::prepareViewDisplay($type, $display);
        $source_name = $this->getSourceFieldDefinition($type)
            ->getName();
        $source_component = $display->getComponent($source_name) ?: [];
        $source_component['type'] = 'entity_reference_entity_id';
        $display->setComponent($source_name, $source_component);
    }
    
    /**
     * {@inheritdoc}
     */
    public function prepareFormDisplay(MediaTypeInterface $type, EntityFormDisplayInterface $display) {
        parent::prepareFormDisplay($type, $display);
        $source_name = $this->getSourceFieldDefinition($type)
            ->getName();
        $source_component = $display->getComponent($source_name) ?: [];
        $source_component['type'] = 'entity_reference_autocomplete_tags';
        $display->setComponent($source_name, $source_component);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getSourceFieldName() {
        return 'field_media_different_display';
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
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::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::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. 2
MediaSourceInterface::METADATA_FIELD_EMPTY constant Default empty value for metadata fields.
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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 PluginInspectionInterface::getPluginDefinition
TestDifferentDisplays::getSourceFieldName protected function Determine the name of the source field. Overrides MediaSourceBase::getSourceFieldName
TestDifferentDisplays::prepareFormDisplay public function Prepares the media type fields for this source in the form display. Overrides MediaSourceBase::prepareFormDisplay
TestDifferentDisplays::prepareViewDisplay public function Prepares the media type fields for this source in the view display. Overrides MediaSourceBase::prepareViewDisplay

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.