aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/embed/src/EmbedType/EmbedTypeInterface.php

   1 <?php
   2
   3 namespace Drupal\embed\EmbedType;
   4
   5 use Drupal\Component\Plugin\PluginInspectionInterface;
   6 use Drupal\Component\Plugin\ConfigurablePluginInterface;
   7 use Drupal\Core\Plugin\PluginFormInterface;
   8
   9 /**
  10  * Provides an interface for an embed type and its metadata.
  11  *
  12  * @ingroup embed_api
  13  */
  14 interface EmbedTypeInterface extends ConfigurablePluginInterface, PluginFormInterface, PluginInspectionInterface {
  15
  16   /**
  17    * Gets a configuration value.
  18    *
  19    * @param string $name
  20    *   The name of the plugin configuration value.
  21    * @param mixed $default
  22    *   The default value to return if the configuration value does not exist.
  23    *
  24    * @return mixed
  25    *   The currently set configuration value, or the value of $default if the
  26    *   configuration value is not set.
  27    */
  28   public function getConfigurationValue($name, $default = NULL);
  29
  30   /**
  31    * Sets a configuration value.
  32    *
  33    * @param string $name
  34    *   The name of the plugin configuration value.
  35    * @param mixed $value
  36    *   The value to set.
  37    */
  38   public function setConfigurationValue($name, $value);
  39
  40   /**
  41    * Gets the default icon URL for the embed type.
  42    *
  43    * @return string
  44    *   The URL to the default icon. Must have been passed through
  45    *   file_create_url() if the file is local.
  46    *
  47    * @see file_create_url()
  48    */
  49   public function getDefaultIconUrl();
  50
  51 }