class Video in Lightning Media 8.3

Input-matching version of the VideoEmbedField media type.

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\video_embed_media\Plugin\media\Source\VideoEmbedField
        • class \Drupal\lightning_media_video\Plugin\media\Source\Video implements InputMatchInterface

1 file declares its use of Video

lightning_media_video.module in modules/lightning_media_video/lightning_media_video.module

Support for videos as media entities in Lightning.

1 string reference to 'Video'

media.type.video.yml in modules/lightning_media_video/config/install/media.type.video.yml

modules/lightning_media_video/config/install/media.type.video.yml

File

modules/lightning_media_video/src/Plugin/media/Source/Video.php, line 12

Namespace

Drupal\lightning_media_video\Plugin\media\Source

class Video extends VideoEmbedField implements InputMatchInterface {

  /**
   * {@inheritdoc}
   */
  public function appliesTo($value, MediaTypeInterface $media_type) {
    $value = $this
      ->toString($value);
    return isset($value) ? (bool) $this->providerManager
      ->loadProviderFromInput($value) : FALSE;
  }

  /**
   * Safely converts a value to a string.
   *
   * The value is converted if it is either scalar, or an object with a
   * __toString() method.
   *
   * @param mixed $value
   *   The value to convert.
   *
   * @return string|null
   *   The string representation of the value, or NULL if the value cannot be
   *   converted to a string.
   */
  protected function toString($value) {
    return is_scalar($value) || is_object($value) && method_exists($value, '__toString') ? (string) $value : NULL;
  }

}

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
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::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
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
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.
Video::appliesTo	public	function	Checks if this media type can handle a given input value. Overrides InputMatchInterface::appliesTo
Video::toString	protected	function	Safely converts a value to a string.
VideoEmbedField::$mediaSettings	protected	property	The media settings.
VideoEmbedField::$providerManager	protected	property	The video provider manager.
VideoEmbedField::create	public static	function	Creates an instance of the plugin. Overrides MediaSourceBase::create
VideoEmbedField::createSourceField	public	function	Creates the source field definition for a type. Overrides MediaSourceBase::createSourceField
VideoEmbedField::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides MediaSourceBase::defaultConfiguration
VideoEmbedField::getMetadata	public	function	Gets the value for a metadata attribute for a given media item. Overrides MediaSourceBase::getMetadata
VideoEmbedField::getMetadataAttributes	public	function	Gets a list of metadata attributes provided by this plugin. Overrides MediaSourceInterface::getMetadataAttributes
VideoEmbedField::getSourceFieldDefinition	public	function	Get the source field definition for a media type. Overrides MediaSourceBase::getSourceFieldDefinition
VideoEmbedField::getVideoUrl	protected	function	Get the video URL from a media entity.
VideoEmbedField::__construct	public	function	Constructs a new class instance. Overrides MediaSourceBase::__construct