public function FileKeyProvider::buildConfigurationForm in Key 8

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form: An associative array containing the initial structure of the plugin form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides PluginFormInterface::buildConfigurationForm

File

src/Plugin/KeyProvider/FileKeyProvider.php, line 40

Class

FileKeyProvider

Adds a key provider that allows a key to be stored in a file.

Namespace

Drupal\key\Plugin\KeyProvider

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form['file_location'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('File location'),
    '#description' => $this
      ->t('The location of the file in which the key will be stored. The path may be absolute (e.g., %abs), relative to the Drupal directory (e.g., %rel), or defined using a stream wrapper (e.g., %str).', [
      '%abs' => '/etc/keys/foobar.key',
      '%rel' => '../keys/foobar.key',
      '%str' => 'private://keys/foobar.key',
    ]),
    '#required' => TRUE,
    '#default_value' => $this
      ->getConfiguration()['file_location'],
  ];
  $form['strip_line_breaks'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Strip trailing line breaks'),
    '#description' => $this
      ->t('Check this to remove any trailing line breaks from the file. Leave unchecked if there is a chance that a line break could be a valid character in the key.'),
    '#default_value' => $this
      ->getConfiguration()['strip_line_breaks'],
  ];

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

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