You are here

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

class VideoFilterBase in Video Filter 8

Defines base methods for all video filter plugin instances.

Hierarchy

Expanded class hierarchy of VideoFilterBase

39 files declare their use of VideoFilterBase
ArchiveOrg.php in src/Plugin/VideoFilter/ArchiveOrg.php
Brightcove.php in src/Plugin/VideoFilter/Brightcove.php
Capped.php in src/Plugin/VideoFilter/Capped.php
CollegeHumor.php in src/Plugin/VideoFilter/CollegeHumor.php
Coub.php in src/Plugin/VideoFilter/Coub.php

... See full list

File

src/VideoFilterBase.php, line 11

Namespace

Drupal\video_filter
View source 
class VideoFilterBase extends PluginBase implements VideoFilterInterface {
  use StringTranslationTrait;

  /**
   * Get plugin name.
   */
  public function getName() {
    return $this->pluginDefinition['name'];
  }

  /**
   * Get plugin example URL.
   */
  public function getExampleURL() {
    return $this->pluginDefinition['example_url'];
  }

  /**
   * Get plugin regexp.
   */
  public function getRegexp() {
    return $this->pluginDefinition['regexp'];
  }

  /**
   * Get video player ratio.
   */
  public function getRatio() {
    $ratio = !empty($this->pluginDefinition['ratio']) ? $this->pluginDefinition['ratio'] : '';
    if (!empty($ratio) && preg_match('/(\\d+)\\/(\\d+)/', $ratio, $tratio)) {
      return $tratio[1] / $tratio[2];
    }
    return 1;
  }

  /**
   * Get video player control bar height.
   */
  public function getControlBarHeight() {
    return !empty($this->pluginDefinition['control_bar_height']) ? $this->pluginDefinition['control_bar_height'] : '';
  }

  /**
   * Get Video Filter coded usage instructions.
   */
  public function instructions() {

    // Return text of the instruction for the codec.
  }

  /**
   * HTML5 video (iframe).
   */
  public function iframe($video) {

    // Return HTML5 URL to the video
    // This URL will be passed int iframe.
  }

  /**
   * Flash video (flv)
   */
  public function flash($video) {

    // Usually video URL that will be played
    // with the FLV player.
  }

  /**
   * HTML code of the video player.
   */
  public function html($video) {

    // Usually video URL that will be played
    // with the FLV player.
  }

  /**
   * Embed options. (e.g. Autoplay, Width/Height).
   *
   * Uses Drupal's Form API.
   */
  public function options() {
    $form['width'] = [
      '#title' => $this
        ->t('Width (optional)'),
      '#type' => 'textfield',
      '#attributes' => [
        'placeholder' => '400',
      ],
    ];
    $form['height'] = [
      '#title' => $this
        ->t('Height (optional)'),
      '#type' => 'textfield',
      '#attributes' => [
        'placeholder' => '400',
      ],
    ];
    return $form;
  }

  /**
   * Get video preview image.
   *
   * This video will be used in CKEditor.
   */
  public function preview($video) {

    // Returns absolute URL to preview image.
    return drupal_get_path('module', 'video_filter') . '/assets/preview.png';
  }

}

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::flash public function Flash video (flv) Overrides VideoFilterInterface::flash 15
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::iframe public function HTML5 video (iframe). Overrides VideoFilterInterface::iframe 23
VideoFilterBase::instructions public function Get Video Filter coded usage instructions. Overrides VideoFilterInterface::instructions 2
VideoFilterBase::options public function Embed options. (e.g. Autoplay, Width/Height). Overrides VideoFilterInterface::options 16
VideoFilterBase::preview public function Get video preview image. Overrides VideoFilterInterface::preview