interface KeyInputInterface in Key 8

Provides an interface for Key Input plugins.

Hierarchy

• interface \Drupal\key\Plugin\KeyInputInterface

File

src/Plugin/KeyInputInterface.php, line 10

Namespace

Drupal\key\Plugin

interface KeyInputInterface {

  /**
   * Process a submitted key value.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   *
   * @return array
   *   The submitted value (with index "submitted") and the processed
   *   value (with index "processed_submitted").
   */
  public function processSubmittedKeyValue(FormStateInterface $form_state);

  /**
   * Process an existing key value.
   *
   * @param string $key_value
   *   The existing key value.
   *
   * @return string
   *   The processed key value.
   */
  public function processExistingKeyValue($key_value);

}

Members

Name	Modifiers	Type	Description	Overrides
KeyInputInterface::processExistingKeyValue	public	function	Process an existing key value.	1
KeyInputInterface::processSubmittedKeyValue	public	function	Process a submitted key value.	1