You are here

Home » API reference » Webform Encrypt 8 » WebformElementEncrypt.php

class WebformElementEncrypt in Webform Encrypt 8

Provides a webform element for element attributes.

Plugin annotation

@FormElement("webform_element_encrypt");

Hierarchy

Expanded class hierarchy of WebformElementEncrypt

1 #type use of WebformElementEncrypt
webform_encrypt_form_webform_ui_element_form_alter in ./webform_encrypt.module
Implements hook_form_FORM_ID_alter().

File

src/Element/WebformElementEncrypt.php, line 14

Namespace

Drupal\webform_encrypt\Element
View source 
class WebformElementEncrypt extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#process' => [
        [
          $class,
          'processWebformElementEncrypt',
        ],
      ],
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
  }

  /**
   * Processes element attributes.
   */
  public static function processWebformElementEncrypt(&$element, FormStateInterface $form_state, &$complete_form) {
    $webform = $config = $form_state
      ->getFormObject()
      ->getWebform();
    $values = $form_state
      ->getValues();
    $element_name = $values['key'];
    $config = $webform
      ->getThirdPartySetting('webform_encrypt', 'element');
    $encryption_options = \Drupal::service('encrypt.encryption_profile.manager')
      ->getEncryptionProfileNamesAsOptions();
    if (count($encryption_options) > 0) {
      $element['element_encrypt']['encrypt'] = [
        '#type' => 'checkbox',
        '#title' => t("Encrypt this field's value"),
        '#description' => t('<a href=":link">Edit encryption settings.</a>', [
          ':link' => Url::fromRoute('entity.encryption_profile.collection')
            ->toString(),
        ]),
        '#default_value' => isset($config[$element_name]['encrypt']) ? $config[$element_name]['encrypt'] : FALSE,
      ];
      $element['element_encrypt']['encrypt_profile'] = [
        '#type' => 'select',
        '#title' => t('Select Encryption Profile'),
        '#options' => $encryption_options,
        '#default_value' => isset($config[$element_name]['encrypt_profile']) ? $config[$element_name]['encrypt_profile'] : NULL,
        '#states' => [
          'visible' => [
            [
              ':input[name="encrypt"]' => [
                'checked' => TRUE,
              ],
            ],
          ],
        ],
      ];
      $element['#element_validate'] = [
        [
          get_called_class(),
          'validateWebformElementEncrypt',
        ],
      ];
    }
    else {
      $element['element_encrypt']['message'] = [
        '#markup' => t('Please configure the encryption profile to enable encryption for the element.'),
      ];
    }
    return $element;
  }

  /**
   * Validates element attributes.
   */
  public static function validateWebformElementEncrypt(&$element, FormStateInterface $form_state, &$complete_form) {
    $webform = $form_state
      ->getFormObject()
      ->getWebform();
    $values = $form_state
      ->getValues();
    $element_name = $values['key'];
    $config = $webform
      ->getThirdPartySetting('webform_encrypt', 'element');

    // To avoid generating an unnecessary dependencies on webform_encrypt:
    // 1. Only set our third party settings if we are encrypting the element.
    // 2. Unset our third party settings if not encrypting the element.
    if (isset($values['encrypt']) && $values['encrypt'] == 1) {
      $config[$element_name] = [
        'encrypt' => $values['encrypt'],
        'encrypt_profile' => $values['encrypt_profile'],
      ];
    }
    else {
      unset($config[$element_name]);
    }
    if (empty($config)) {
      $webform
        ->unsetThirdPartySetting('webform_encrypt', 'element');
    }
    else {
      $webform
        ->setThirdPartySetting('webform_encrypt', 'element', $config);
    }
  }

}

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
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.
WebformElementEncrypt::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
WebformElementEncrypt::processWebformElementEncrypt public static function Processes element attributes.
WebformElementEncrypt::validateWebformElementEncrypt public static function Validates element attributes.
WebformElementEncrypt::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback