KeyInputInterface.php in Key 8

Namespace

Drupal\key\Plugin

File

src/Plugin/KeyInputInterface.php

<?php

namespace Drupal\key\Plugin;

use Drupal\Core\Form\FormStateInterface;

/**
 * Provides an interface for Key Input plugins.
 */
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);

}

Interfaces

Name	Description
KeyInputInterface	Provides an interface for Key Input plugins.