interface EmbedTypeInterface in Embed 8

Provides an interface for an embed type and its metadata.

Hierarchy

• interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\embed\EmbedType\EmbedTypeInterface

File

src/EmbedType/EmbedTypeInterface.php, line 15

Namespace

Drupal\embed\EmbedType

interface EmbedTypeInterface extends ConfigurableInterface, DependentPluginInterface, PluginFormInterface, PluginInspectionInterface {

  /**
   * Gets a configuration value.
   *
   * @param string $name
   *   The name of the plugin configuration value.
   * @param mixed $default
   *   The default value to return if the configuration value does not exist.
   *
   * @return mixed
   *   The currently set configuration value, or the value of $default if the
   *   configuration value is not set.
   */
  public function getConfigurationValue($name, $default = NULL);

  /**
   * Sets a configuration value.
   *
   * @param string $name
   *   The name of the plugin configuration value.
   * @param mixed $value
   *   The value to set.
   */
  public function setConfigurationValue($name, $value);

  /**
   * Gets the default icon URL for the embed type.
   *
   * @return string
   *   The URL to the default icon. Must have been passed through
   *   file_create_url() if the file is local.
   *
   * @see file_create_url()
   */
  public function getDefaultIconUrl();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
EmbedTypeInterface::getConfigurationValue	public	function	Gets a configuration value.	1
EmbedTypeInterface::getDefaultIconUrl	public	function	Gets the default icon URL for the embed type.	3
EmbedTypeInterface::setConfigurationValue	public	function	Sets a configuration value.	1
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2