class YouTube in Video Embed Field 8

A YouTube provider plugin.

Plugin annotation

@VideoEmbedProvider(
  id = "youtube",
  title = @Translation("YouTube")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\video_embed_field\ProviderPluginBase implements ContainerFactoryPluginInterface, ProviderPluginInterface
      • class \Drupal\video_embed_field\Plugin\video_embed_field\Provider\YouTube

1 file declares its use of YouTube

ProviderUrlParseTest.php in tests/src/Unit/ProviderUrlParseTest.php

File

src/Plugin/video_embed_field/Provider/YouTube.php, line 15

Namespace

Drupal\video_embed_field\Plugin\video_embed_field\Provider

class YouTube extends ProviderPluginBase {

  /**
   * {@inheritdoc}
   */
  public function renderEmbedCode($width, $height, $autoplay) {
    $embed_code = [
      '#type' => 'video_embed_iframe',
      '#provider' => 'youtube',
      '#url' => sprintf('https://www.youtube.com/embed/%s', $this
        ->getVideoId()),
      '#query' => [
        'autoplay' => $autoplay,
        'start' => $this
          ->getTimeIndex(),
        'rel' => '0',
      ],
      '#attributes' => [
        'width' => $width,
        'height' => $height,
        'frameborder' => '0',
        'allowfullscreen' => 'allowfullscreen',
      ],
    ];
    if ($language = $this
      ->getLanguagePreference()) {
      $embed_code['#query']['cc_lang_pref'] = $language;
    }
    return $embed_code;
  }

  /**
   * Get the time index for when the given video starts.
   *
   * @return int
   *   The time index where the video should start based on the URL.
   */
  protected function getTimeIndex() {
    preg_match('/[&\\?]t=((?<hours>\\d+)h)?((?<minutes>\\d+)m)?(?<seconds>\\d+)s?/', $this
      ->getInput(), $matches);
    $hours = !empty($matches['hours']) ? $matches['hours'] : 0;
    $minutes = !empty($matches['minutes']) ? $matches['minutes'] : 0;
    $seconds = !empty($matches['seconds']) ? $matches['seconds'] : 0;
    return $hours * 3600 + $minutes * 60 + $seconds;
  }

  /**
   * Extract the language preference from the URL for use in closed captioning.
   *
   * @return string|FALSE
   *   The language preference if one exists or FALSE if one could not be found.
   */
  protected function getLanguagePreference() {
    preg_match('/[&\\?]hl=(?<language>[a-z\\-]*)/', $this
      ->getInput(), $matches);
    return isset($matches['language']) ? $matches['language'] : FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getRemoteThumbnailUrl() {
    $url = 'http://img.youtube.com/vi/%s/%s.jpg';
    $high_resolution = sprintf($url, $this
      ->getVideoId(), 'maxresdefault');
    $backup = sprintf($url, $this
      ->getVideoId(), 'mqdefault');
    try {
      $this->httpClient
        ->head($high_resolution);
      return $high_resolution;
    } catch (\Exception $e) {
      return $backup;
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function getIdFromInput($input) {
    preg_match('/^https?:\\/\\/(www\\.)?((?!.*list=)youtube\\.com\\/watch\\?.*v=|youtu\\.be\\/)(?<id>[0-9A-Za-z_-]*)/', $input, $matches);
    return isset($matches['id']) ? $matches['id'] : FALSE;
  }

}

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
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.
ProviderPluginBase::$fileSystem	protected	property
ProviderPluginBase::$httpClient	protected	property	An http client.
ProviderPluginBase::$input	protected	property	The input that caused the embed provider to be selected.
ProviderPluginBase::$thumbsDirectory	protected	property	The directory where thumbnails are stored.
ProviderPluginBase::$videoId	protected	property	The ID of the video.
ProviderPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ProviderPluginBase::downloadThumbnail	public	function	Download the remote thumbnail URL to the local thumbnail URI. Overrides ProviderPluginInterface::downloadThumbnail
ProviderPluginBase::getFileSystem	protected	function	Get the file system service.
ProviderPluginBase::getInput	protected	function	Get the input which caused this plugin to be selected.
ProviderPluginBase::getLocalThumbnailUri	public	function	Get the URL to the local thumbnail. Overrides ProviderPluginInterface::getLocalThumbnailUri
ProviderPluginBase::getName	public	function	Get the name of the video. Overrides ProviderPluginInterface::getName	1
ProviderPluginBase::getVideoId	protected	function	Get the ID of the video.
ProviderPluginBase::isApplicable	public static	function	Check if the plugin is applicable to the user input. Overrides ProviderPluginInterface::isApplicable
ProviderPluginBase::renderThumbnail	public	function	Render a thumbnail. Overrides ProviderPluginInterface::renderThumbnail
ProviderPluginBase::__construct	public	function	Create a plugin with the given input. Overrides PluginBase::__construct
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.
YouTube::getIdFromInput	public static	function	Get the ID of the video from user input. Overrides ProviderPluginInterface::getIdFromInput
YouTube::getLanguagePreference	protected	function	Extract the language preference from the URL for use in closed captioning.
YouTube::getRemoteThumbnailUrl	public	function	Get the URL of the remote thumbnail. Overrides ProviderPluginInterface::getRemoteThumbnailUrl
YouTube::getTimeIndex	protected	function	Get the time index for when the given video starts.
YouTube::renderEmbedCode	public	function	Render embed code. Overrides ProviderPluginInterface::renderEmbedCode