www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/video/src/ProviderManagerInterface.php

   1 <?php
   2
   3 /**
   4  * @file
   5  * Contains \Drupal\video\VideoProviderManagerInterface.
   6  */
   7
   8 namespace Drupal\video;
   9
  10 /**
  11  * Interface for the class that gathers the provider plugins.
  12  */
  13 interface ProviderManagerInterface {
  14
  15   /**
  16    * Get an options list suitable for form elements for provider selection.
  17    *
  18    * @return array
  19    *   An array of options keyed by plugin ID with label values.
  20    */
  21   public function getProvidersOptionList();
  22
  23   /**
  24    * Load the provider plugin definitions from a FAPI options list value.
  25    *
  26    * @param array $options
  27    *   An array of options from a form API submission.
  28    *
  29    * @return array
  30    */
  31   public function loadDefinitionsFromOptionList($options);
  32
  33   /**
  34    * Get the provider applicable to the given user input.
  35    *
  36    * @param array $definitions
  37    *   A list of definitions to test against.
  38    * @param $user_input
  39    *   The user input to test against the plugins.
  40    *
  41    * @return \Drupal\video\ProviderPluginInterface|bool
  42    *   The relevant plugin or FALSE on failure.
  43    */
  44   public function loadApplicableDefinitionMatches(array $definitions, $user_input);
  45
  46   /**
  47    * Load a provider from stream wrapper.
  48    *
  49    * @param string $stream
  50    *   Stream used from the file.
  51    *
  52    * @param Drupal\file\Entity\File $file
  53    *   The source file.
  54    *
  55    * @param array $data
  56    *   Source file metadata.
  57    *
  58    * @return \Drupal\video\ProviderPluginInterface|bool
  59    *   The loaded plugin.
  60    */
  61   public function loadProviderFromStream($stream, $file, $data = array());
  62
  63 }