class BackgroundImageMedia in Background Image Field 8

Image entity media source.

Plugin annotation

@MediaSource(
  id = "bg_img_media_field",
  label = @Translation("Background Image"),
  description = @Translation("Use local images for reusable media."),
  allowed_field_types = {"bg_img_field"},
  default_thumbnail_filename = "no-thumbnail.png",
  thumbnail_alt_metadata_attribute = "thumbnail_alt_value"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\media\MediaSourceBase implements ContainerFactoryPluginInterface, MediaSourceInterface
      • class \Drupal\media\Plugin\media\Source\File
        • class \Drupal\media\Plugin\media\Source\Image
          • class \Drupal\bg_img_field\Plugin\media\Source\BackgroundImageMedia

See also

\Drupal\Core\Image\ImageInterface

File

src/Plugin/media/Source/BackgroundImageMedia.php, line 20

Namespace

Drupal\bg_img_field\Plugin\media\Source

class BackgroundImageMedia extends Image {

}

Members

Name	Modifiers	Type	Description	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		1
DependencySerializationTrait::__wakeup	public	function		2
File::getThumbnail	protected	function	Gets the thumbnail image URI based on a file entity.
File::METADATA_ATTRIBUTE_MIME		constant	Key for "MIME type" metadata attribute.
File::METADATA_ATTRIBUTE_NAME		constant	Key for "Name" metadata attribute.
File::METADATA_ATTRIBUTE_SIZE		constant	Key for "File size" metadata attribute.
Image::$fileSystem	protected	property	The file system service.
Image::$imageFactory	protected	property	The image factory service.
Image::create	public static	function	Creates an instance of the plugin. Overrides MediaSourceBase::create
Image::createSourceField	public	function	Creates the source field definition for a type. Overrides File::createSourceField
Image::getMetadata	public	function	Gets the value for a metadata attribute for a given media item. Overrides File::getMetadata
Image::getMetadataAttributes	public	function	Gets a list of metadata attributes provided by this plugin. Overrides File::getMetadataAttributes
Image::METADATA_ATTRIBUTE_HEIGHT		constant	Key for "image height" metadata attribute.
Image::METADATA_ATTRIBUTE_WIDTH		constant	Key for "image width" metadata attribute.
Image::prepareViewDisplay	public	function	Prepares the media type fields for this source in the view display. Overrides MediaSourceBase::prepareViewDisplay
Image::__construct	public	function	Constructs a new class instance. Overrides MediaSourceBase::__construct
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::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	2
MediaSourceBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
MediaSourceBase::createSourceFieldStorage	protected	function	Creates the source field storage definition.
MediaSourceBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	2
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::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
MediaSourceInterface::METADATA_FIELD_EMPTY		constant	Default empty value for metadata fields.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
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.	1
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.