You are here

Home » API reference » Key 8 » TextFieldKeyInput.php

class TextFieldKeyInput in Key 8

Defines a key input that provides a simple text field.

Plugin annotation


@KeyInput(
  id = "text_field",
  label = @Translation("Text field"),
  description = @Translation("A simple text field.")
)

Hierarchy

Expanded class hierarchy of TextFieldKeyInput

File

src/Plugin/KeyInput/TextFieldKeyInput.php, line 17

Namespace

Drupal\key\Plugin\KeyInput
View source 
class TextFieldKeyInput extends KeyInputBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'key_value' => '',
      'base64_encoded' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $key_value_data = $form_state
      ->get('key_value');

    /** @var \Drupal\key\Entity\Key $key */
    $key = $form_state
      ->getFormObject()
      ->getEntity();
    $form['key_value'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Key value'),
      '#required' => $key
        ->getKeyProvider()
        ->getPluginDefinition()['key_value']['required'],
      '#maxlength' => 4096,
      '#default_value' => $key_value_data['current'],
      // Tell the browser not to autocomplete this field.
      '#attributes' => [
        'autocomplete' => 'off',
      ],
    ];

    // If this key input is for an encryption key.
    if ($key
      ->getKeyType()
      ->getPluginDefinition()['group'] == 'encryption') {

      // Add an option to indicate that the value is Base64-encoded.
      $form['base64_encoded'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Base64-encoded'),
        '#description' => $this
          ->t('Check this if the key value being submitted has been Base64-encoded.'),
        '#default_value' => $this
          ->getConfiguration()['base64_encoded'],
      ];
    }
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
KeyInputBase::processExistingKeyValue public function Process an existing key value. Overrides KeyInputInterface::processExistingKeyValue 1
KeyInputBase::processSubmittedKeyValue public function Process a submitted key value. Overrides KeyInputInterface::processSubmittedKeyValue 2
KeyInputBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
KeyInputBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
KeyPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
KeyPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
KeyPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
KeyPluginBase::getPluginType public function Returns the type of plugin. Overrides KeyPluginInterface::getPluginType
KeyPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
KeyPluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TextFieldKeyInput::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 1
TextFieldKeyInput::defaultConfiguration public function Gets default configuration for this plugin. Overrides KeyPluginBase::defaultConfiguration