interface TamperPluginInterface in Tamper 7

Plugin interface for providing plugins to tamper.

Hierarchy

• interface \TamperPluginInterface

File

src/Tamper.php, line 133

Contains TamperPluginBase.

interface TamperPluginInterface {

  /**
   * Returns the plugin_id of the plugin instance.
   *
   * @return string
   *   The plugin_id of the plugin instance.
   */
  public function getPluginId();

  /**
   * Returns the definition of the plugin implementation.
   *
   * @return array
   *   The plugin definition, as returned by the discovery object used by the
   *   plugin manager.
   */
  public function getPluginDefinition();

  /**
   * Returns this plugin's configuration.
   *
   * @return array
   *   An array of this plugin's configuration.
   */
  public function getConfiguration();

  /**
   * Sets the configuration for this plugin instance.
   *
   * @param array $configuration
   *   An associative array containing the plugin's configuration.
   */
  public function setConfiguration(array $configuration);

  /**
   * Returns default configuration for this plugin.
   *
   * @return array
   *   An associative array with the default configuration.
   */
  public function defaultConfiguration();

  /**
   * Form constructor.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param array &$form_state
   *   An associative array containing the current state of the form.
   *
   * @return array
   *   The form structure.
   */
  public function buildConfigurationForm(array $form, array &$form_state);

  /**
   * Form validation handler.
   *
   * @param array &$form
   *   An associative array containing the structure of the form.
   * @param array &$form_state
   *   An associative array containing the current state of the form.
   */
  public function validateConfigurationForm(array &$form, array &$form_state);

  /**
   * Form submission handler.
   *
   * @param array &$form
   *   An associative array containing the structure of the form.
   * @param array &$form_state
   *   An associative array containing the current state of the form.
   */
  public function submitConfigurationForm(array &$form, array &$form_state);

  /**
   * Executes the plugin.
   *
   * @param string $value
   *   The value to transform.
   *
   * @return string
   *   The transformed value.
   */
  public function execute($value);

  /**
   * Executes the plugin on multiple values.
   *
   * @param []string $values
   *   The list of values to execute.
   *
   * @return []string
   *   The list of transformed values.
   */
  public function executeMultiple(array $values);

}

Members

Name	Modifiers	Type	Description	Overrides
TamperPluginInterface::buildConfigurationForm	public	function	Form constructor.	1
TamperPluginInterface::defaultConfiguration	public	function	Returns default configuration for this plugin.	1
TamperPluginInterface::execute	public	function	Executes the plugin.	1
TamperPluginInterface::executeMultiple	public	function	Executes the plugin on multiple values.	1
TamperPluginInterface::getConfiguration	public	function	Returns this plugin's configuration.	1
TamperPluginInterface::getPluginDefinition	public	function	Returns the definition of the plugin implementation.	1
TamperPluginInterface::getPluginId	public	function	Returns the plugin_id of the plugin instance.	1
TamperPluginInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	1
TamperPluginInterface::submitConfigurationForm	public	function	Form submission handler.	1
TamperPluginInterface::validateConfigurationForm	public	function	Form validation handler.	1