class ExampleCodec in Video Filter 8

Provides ExampleCodec codec for Video Filter.

Plugin annotation

@VideoFilter(
  id = "example",
  name = @Translation("Example"),
  example_url = "https://www.drupal.org/project/video_filter",
  regexp = {
    "/drupal\.org\/project\/([0-9a-z_]+)/i",
  },
  ratio = "4/3",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\video_filter\VideoFilterBase implements VideoFilterInterface uses StringTranslationTrait
    • class \Drupal\video_filter_example\Plugin\VideoFilter\ExampleCodec

File

modules/video_filter_example/src/Plugin/VideoFilter/ExampleCodec.php, line 20

Namespace

Drupal\video_filter_example\Plugin\VideoFilter

class ExampleCodec extends VideoFilterBase {

  /**
   * {@inheritdoc}
   */
  public function iframe($video) {
    return [
      'src' => '//www.drupal.org/project/' . $video['codec']['matches'][1],
      'properties' => [
        'allowfullscreen' => 'true',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function flash($video) {

    // See Youtube.php for implementation example.
    // or any other plugins.
  }

  /**
   * {@inheritdoc}
   */
  public function html($video) {

    // HTML code of the video. In case if you would like to use oembed.
  }

  /**
   * {@inheritdoc}
   */
  public function options() {
    $form['width'] = [
      '#title' => $this
        ->t('Width (optional)'),
      '#type' => 'textfield',
    ];
    $form['height'] = [
      '#title' => $this
        ->t('Height (optional)'),
      '#type' => 'textfield',
    ];
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ExampleCodec::flash	public	function	Flash video (flv) Overrides VideoFilterBase::flash
ExampleCodec::html	public	function	HTML code of the video player. Overrides VideoFilterBase::html
ExampleCodec::iframe	public	function	HTML5 video (iframe). Overrides VideoFilterBase::iframe
ExampleCodec::options	public	function	Embed options. (e.g. Autoplay, Width/Height). Overrides VideoFilterBase::options
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::instructions	public	function	Get Video Filter coded usage instructions. Overrides VideoFilterInterface::instructions	2
VideoFilterBase::preview	public	function	Get video preview image. Overrides VideoFilterInterface::preview