class VarbaseMediaRemoteVideo in Varbase Media 9.0.x

Input-matching version of the Varbase Media Remote Video media source.

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\OEmbed implements OEmbedInterface
        • class \Drupal\varbase_media\Plugin\media\Source\VarbaseMediaRemoteVideo implements InputMatchInterface

1 file declares its use of VarbaseMediaRemoteVideo

varbase_media.module in ./varbase_media.module

Contains varbase_media.module.

File

src/Plugin/media/Source/VarbaseMediaRemoteVideo.php, line 13

Namespace

Drupal\varbase_media\Plugin\media\Source

class VarbaseMediaRemoteVideo extends DrupalCoreOEmbed implements InputMatchInterface {

  /**
   * {@inheritdoc}
   */
  public function appliesTo($value, MediaTypeInterface $bundle) {
    $url = $this
      ->toString($value);
    $constraint = new OEmbedResourceConstraint();

    // Ensure that the URL matches a provider.
    try {
      $provider = $this->urlResolver
        ->getProviderByUrl($url);
    } catch (ResourceException $e) {
      $this
        ->handleException($e, $constraint->unknownProviderMessage);
      return FALSE;
    } catch (ProviderException $e) {
      $this
        ->handleException($e, $constraint->providerErrorMessage);
      return FALSE;
    }

    // Ensure that the provider is allowed.
    if (!in_array($provider
      ->getName(), $this
      ->getProviders(), TRUE)) {
      return FALSE;
    }
    try {
      $endpoints = $provider
        ->getEndpoints();
      $resource_url = reset($endpoints)
        ->buildResourceUrl($url);
      $this->resourceFetcher
        ->fetchResource($resource_url);
      return TRUE;
    } catch (ResourceException $e) {
      $this
        ->handleException($e, $constraint->invalidResourceMessage);
    }
    return 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
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
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::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::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::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
MediaSourceInterface::METADATA_FIELD_EMPTY		constant	Default empty value for metadata fields.
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
OEmbed::$fileSystem	protected	property	The file system.
OEmbed::$httpClient	protected	property	The HTTP client.
OEmbed::$iFrameUrlHelper	protected	property	The iFrame URL helper service.
OEmbed::$logger	protected	property	The logger channel for media.
OEmbed::$messenger	protected	property	The messenger service. Overrides MessengerTrait::$messenger
OEmbed::$resourceFetcher	protected	property	The oEmbed resource fetcher service.
OEmbed::$urlResolver	protected	property	The OEmbed manager service.
OEmbed::buildConfigurationForm	public	function	Form constructor. Overrides MediaSourceBase::buildConfigurationForm
OEmbed::create	public static	function	Creates an instance of the plugin. Overrides MediaSourceBase::create
OEmbed::createSourceField	public	function	Creates the source field definition for a type. Overrides MediaSourceBase::createSourceField
OEmbed::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides MediaSourceBase::defaultConfiguration
OEmbed::getLocalThumbnailUri	protected	function	Returns the local URI for a resource thumbnail.
OEmbed::getMetadata	public	function	Gets the value for a metadata attribute for a given media item. Overrides MediaSourceBase::getMetadata
OEmbed::getMetadataAttributes	public	function	Gets a list of metadata attributes provided by this plugin. Overrides MediaSourceInterface::getMetadataAttributes
OEmbed::getProviders	public	function	Returns the oEmbed provider names. Overrides OEmbedInterface::getProviders
OEmbed::getSourceFieldConstraints	public	function	Gets media source-specific validation constraints for a source field. Overrides MediaSourceFieldConstraintsInterface::getSourceFieldConstraints
OEmbed::getThumbnailFileExtensionFromUrl	protected	function	Tries to determine the file extension of a thumbnail.
OEmbed::prepareFormDisplay	public	function	Prepares the media type fields for this source in the form display. Overrides MediaSourceBase::prepareFormDisplay
OEmbed::prepareViewDisplay	public	function	Prepares the media type fields for this source in the view display. Overrides MediaSourceBase::prepareViewDisplay
OEmbed::submitConfigurationForm	public	function	Form submission handler. Overrides MediaSourceBase::submitConfigurationForm
OEmbed::validateConfigurationForm	public	function	Form validation handler. Overrides MediaSourceBase::validateConfigurationForm
OEmbed::__construct	public	function	Constructs a new OEmbed instance. Overrides MediaSourceBase::__construct
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	2
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.	4
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.
VarbaseMediaRemoteVideo::appliesTo	public	function	Checks if this media type can handle a given input value. Overrides InputMatchInterface::appliesTo
VarbaseMediaRemoteVideo::toString	protected	function	Safely converts a value to a string.