You are here

Home » API reference » Video Filter 8 » Youtube.php

class Youtube in Video Filter 8

Provides Youtube codec for Video Filter.

Plugin annotation


@VideoFilter(
  id = "youtube",
  name = @Translation("YouTube"),
  example_url = "https://www.youtube.com/watch?v=EQ1HKCYJM5U",
  regexp = {
    "/youtube\.com\/watch\?v=([a-z0-9\-_]+)/i",
    "/youtu.be\/([a-z0-9\-_]+)/i",
    "/youtube\.com\/v\/([a-z0-9\-_]+)/i",
  },
  ratio = "16/9",
  control_bar_height = 0
)

Hierarchy

Expanded class hierarchy of Youtube

File

src/Plugin/VideoFilter/Youtube.php, line 23

Namespace

Drupal\video_filter\Plugin\VideoFilter
View source 
class Youtube extends VideoFilterBase {

  /**
   * Video embed tag attributes.
   */
  protected function attributes($video) {
    $attributes = [
      'modestbranding' => !empty($video['modestbranding']) ? 'modestbranding=1' : 'modestbranding=0',
      'html5' => 'html5=1',
      'rel' => !empty($video['related']) ? 'rel=1' : 'rel=0',
      'autoplay' => !empty($video['autoplay']) ? 'autoplay=1' : 'autoplay=0',
      'wmode' => 'wmode=opaque',
      'loop' => !empty($video['loop']) ? 'loop=1' : 'loop=0',
      'controls' => !empty($video['controls']) ? 'controls=' . (int) $video['controls'] : (!isset($video['controls']) ? 'controls=1' : 'controls=0'),
      'autohide' => !empty($video['autohide']) ? 'autohide=1' : 'autohide=0',
      'showinfo' => !empty($video['showinfo']) ? 'showinfo=1' : 'showinfo=0',
      'theme' => !empty($video['theme']) ? 'theme=' . $video['theme'] : 'theme=dark',
      'color' => !empty($video['color']) ? 'color=' . $video['color'] : 'color=red',
    ];

    // YouTube Playlist.
    // Example URL: https://www.youtube.com/watch?v=YQHsXMglC9A&list=PLFgquLnL59alCl_2TQvOiD5Vgm1hCaGSI
    if (preg_match_all('/youtube\\.com\\/watch\\?v=(.*)list=([a-z0-9\\-_]+)/i', $video['source'], $matches)) {
      if (!empty($matches[2][0])) {
        $attributes['list'] = 'list=' . $matches[2][0];
      }
    }
    if (preg_match('/t=((\\d+[m|s])?(\\d+[s]?)?)/', $video['source'], $matches)) {
      $attributes['start'] = 'start=' . (preg_replace("/[^0-9]/", "", $matches[2]) * 60 + preg_replace("/[^0-9]/", "", $matches[3]));
    }
    if (!empty($video['start'])) {
      if (preg_match('/((\\d+[m|s])?(\\d+[s]?)?)/', $video['start'], $matches)) {
        $attributes['start'] = 'start=' . (preg_replace("/[^0-9]/", "", $matches[2]) * 60 + preg_replace("/[^0-9]/", "", $matches[3]));
      }
    }
    return $attributes;
  }

  /**
   * {@inheritdoc}
   */
  public function iframe($video) {
    $attributes = $this
      ->attributes($video);
    return [
      'src' => '//www.youtube.com/embed/' . $video['codec']['matches'][1] . '?' . implode('&', $attributes),
      'properties' => [
        'allowfullscreen' => 'true',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function flash($video) {
    $attributes = $this
      ->attributes($video);
    return [
      'src' => '//www.youtube.com/v/' . $video['codec']['matches'][1] . '?' . implode('&', $attributes),
      'params' => [
        'wmode' => 'opaque',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function options() {
    $form = parent::options();
    $form['autoplay'] = [
      '#title' => $this
        ->t('Autoplay'),
      '#type' => 'checkbox',
    ];
    $form['related'] = [
      '#title' => $this
        ->t('Show related videos'),
      '#type' => 'checkbox',
    ];
    $form['loop'] = [
      '#title' => $this
        ->t('Loop'),
      '#type' => 'checkbox',
    ];
    $form['autohide'] = [
      '#title' => $this
        ->t('Autohide'),
      '#type' => 'checkbox',
    ];
    $form['showinfo'] = [
      '#title' => $this
        ->t('Show info'),
      '#type' => 'checkbox',
    ];
    $form['modestbranding'] = [
      '#title' => $this
        ->t('Modest branding'),
      '#type' => 'checkbox',
    ];
    $form['enablejsapi'] = [
      '#title' => $this
        ->t('Enable control via IFrame or JavaScript Player API calls.'),
      '#type' => 'checkbox',
    ];
    $form['start'] = [
      '#title' => $this
        ->t('Start time (optional)'),
      '#type' => 'textfield',
      '#description' => $this
        ->t('Example: <strong>2m3s</strong> or <strong>15s</strong>.'),
      '#attributes' => [
        'placeholder' => '2m3s',
      ],
    ];
    $form['theme'] = [
      '#title' => $this
        ->t('Theme'),
      '#type' => 'select',
      '#options' => [
        'dark' => $this
          ->t('Dark'),
        'light' => $this
          ->t('Light'),
      ],
      '#description' => $this
        ->t('Setting the color parameter to white will disable the modestbranding option.'),
    ];
    $form['color'] = [
      '#title' => $this
        ->t('Color'),
      '#type' => 'select',
      '#options' => [
        'red' => $this
          ->t('Red'),
        'white' => $this
          ->t('White'),
      ],
      '#description' => $this
        ->t('Setting the color parameter to white will disable the modestbranding option.'),
    ];
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
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.
VideoFilterBase::getControlBarHeight public function Get video player control bar height. Overrides VideoFilterInterface::getControlBarHeight
VideoFilterBase::getExampleURL public function Get plugin example URL. Overrides VideoFilterInterface::getExampleURL
VideoFilterBase::getName public function Get plugin name. Overrides VideoFilterInterface::getName
VideoFilterBase::getRatio public function Get video player ratio. Overrides VideoFilterInterface::getRatio
VideoFilterBase::getRegexp public function Get plugin regexp. Overrides VideoFilterInterface::getRegexp
VideoFilterBase::html public function HTML code of the video player. Overrides VideoFilterInterface::html 6
VideoFilterBase::instructions public function Get Video Filter coded usage instructions. Overrides VideoFilterInterface::instructions 2
VideoFilterBase::preview public function Get video preview image. Overrides VideoFilterInterface::preview
Youtube::attributes protected function Video embed tag attributes.
Youtube::flash public function Flash video (flv) Overrides VideoFilterBase::flash
Youtube::iframe public function HTML5 video (iframe). Overrides VideoFilterBase::iframe
Youtube::options public function Embed options. (e.g. Autoplay, Width/Height). Overrides VideoFilterBase::options