interface ImageEffectsPluginBaseInterface in Image Effects 8

Interface for image_effects base plugin.

Hierarchy

• interface \Drupal\Component\Plugin\ConfigurablePluginInterface; interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface
  • interface \Drupal\image_effects\Plugin\ImageEffectsPluginBaseInterface

4 files declare their use of ImageEffectsPluginBaseInterface

BackgroundImageEffect.php in src/Plugin/ImageEffect/BackgroundImageEffect.php

ImageSelectionImageEffect.php in tests/modules/image_effects_module_test/src/Plugin/ImageEffect/ImageSelectionImageEffect.php

MaskImageEffect.php in src/Plugin/ImageEffect/MaskImageEffect.php

WatermarkImageEffect.php in src/Plugin/ImageEffect/WatermarkImageEffect.php

File

src/Plugin/ImageEffectsPluginBaseInterface.php, line 12

Namespace

Drupal\image_effects\Plugin

interface ImageEffectsPluginBaseInterface extends ConfigurablePluginInterface, ContainerFactoryPluginInterface, PluginFormInterface {

  /**
   * Return a form element to select the plugin content.
   *
   * @param array $options
   *   (Optional) An array of additional Form API keys and values.
   *
   * @return array
   *   Render array of the form element.
   */
  public function selectionElement(array $options = []);

  /**
   * Get the image_effects plugin type.
   *
   * @return string
   *   The plugin type.
   */
  public function getType();

  /**
   * Determines if plugin can be used.
   *
   * @return bool
   *   TRUE if the plugin is available.
   */
  public static function isAvailable();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurablePluginInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	1
ConfigurablePluginInterface::getConfiguration	public	function	Gets this plugin's configuration.	1
ConfigurablePluginInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	1
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	112
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
ImageEffectsPluginBaseInterface::getType	public	function	Get the image_effects plugin type.	1
ImageEffectsPluginBaseInterface::isAvailable	public static	function	Determines if plugin can be used.	1
ImageEffectsPluginBaseInterface::selectionElement	public	function	Return a form element to select the plugin content.	1
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18