You are here

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

class Vimeo in Video Filter 8

Provides Vimeo codec for Video Filter.

Plugin annotation


@VideoFilter(
  id = "vimeo",
  name = @Translation("Vimeo"),
  example_url = "https://vimeo.com/25290459",
  regexp = {
    "/vimeo\.com\/([0-9]+)/",
    "/vimeo\.com\/(.*)\/([0-9]+)/i",
  },
  ratio = "16/9",
  control_bar_height = 0
)

Hierarchy

Expanded class hierarchy of Vimeo

File

src/Plugin/VideoFilter/Vimeo.php, line 22

Namespace

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

  /**
   * Video embed tag attributes.
   */
  protected function attributes($video) {
    $attributes = [
      'autopause' => isset($video['autopause']) ? 'autopause=' . (int) $video['autopause'] : 'autopause=1',
      'autoplay' => isset($video['autoplay']) ? 'autoplay=' . (int) $video['autoplay'] : 'autoplay=0',
      'badge' => isset($video['badge']) ? 'badge=' . (int) $video['badge'] : 'badge=1',
      'byline' => isset($video['byline']) ? 'byline=' . (int) $video['byline'] : 'byline=1',
      'loop' => isset($video['loop']) ? 'loop=' . (int) $video['loop'] : 'loop=0',
      'portrait' => isset($video['portrait']) ? 'portrait=' . (int) $video['portrait'] : 'portrait=1',
      'title' => isset($video['title']) ? 'autopause=' . (int) $video['title'] : 'autopause=1',
      'fullscreen' => isset($video['fullscreen']) ? 'fullscreen=' . (int) $video['fullscreen'] : 'fullscreen=1',
    ];
    if (!empty($video['color'])) {
      $attributes['color'] = (string) $video['color'];
    }
    return $attributes;
  }

  /**
   * {@inheritdoc}
   */
  public function iframe($video) {
    $video_id = !empty($video['codec']['matches'][1]) ? (int) $video['codec']['matches'][1] : '';
    if (empty($video_id)) {

      // Support for editor picks video embed.
      $video_id = !empty($video['codec']['matches'][2]) ? (int) $video['codec']['matches'][2] : '';
    }
    return [
      'src' => '//player.vimeo.com/video/' . $video_id . '?' . implode('&', $this
        ->attributes($video)),
      'properties' => [
        'webkitallowfullscreen' => 'true',
        'mozallowfullscreen' => 'true',
        'allowfullscreen' => 'true',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function flash($video) {
    $attributes = $this
      ->attributes($video);
    $attributes['clip_id'] = $video['codec']['matches'][1];
    return [
      'src' => '//www.vimeo.com/moogaloop.swf?' . implode('&', $attributes),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function options() {
    $form = parent::options();
    $form['autopause'] = [
      '#title' => $this
        ->t('Enable pausing this video when another video is played.'),
      '#type' => 'checkbox',
    ];
    $form['autoplay'] = [
      '#title' => $this
        ->t('Autoplay'),
      '#type' => 'checkbox',
    ];
    $form['badge'] = [
      '#title' => $this
        ->t('Enable the badge on the video.'),
      '#type' => 'checkbox',
    ];
    $form['byline'] = [
      '#title' => $this
        ->t('Show the user’s byline on the video.'),
      '#type' => 'checkbox',
    ];
    $form['loop'] = [
      '#title' => $this
        ->t('Play the video again when it reaches the end.'),
      '#type' => 'checkbox',
    ];
    $form['portrait'] = [
      '#title' => $this
        ->t('Show the user’s portrait on the video.'),
      '#type' => 'checkbox',
    ];
    $form['title'] = [
      '#title' => $this
        ->t('Show the title on the video.'),
      '#type' => 'checkbox',
    ];
    $form['fullscreen'] = [
      '#title' => $this
        ->t('Allow the player to go into fullscreen.'),
      '#type' => 'checkbox',
    ];
    $form['color'] = [
      '#title' => $this
        ->t('Color (optional)'),
      '#type' => 'textfield',
      '#description' => $this
        ->t('Specify the color of the video controls. Defaults to 00adef. Make sure that you don’t include the #.'),
    ];
    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
Vimeo::attributes protected function Video embed tag attributes.
Vimeo::flash public function Flash video (flv) Overrides VideoFilterBase::flash
Vimeo::iframe public function HTML5 video (iframe). Overrides VideoFilterBase::iframe
Vimeo::options public function Embed options. (e.g. Autoplay, Width/Height). Overrides VideoFilterBase::options