You are here

Home » API reference » Webform 8.5 » WebformSubmissionViewsReplace.php

class WebformSubmissionViewsReplace in Webform 8.5

Same name and namespace in other branches
  1. 6.x src/Element/WebformSubmissionViewsReplace.php \Drupal\webform\Element\WebformSubmissionViewsReplace

Provides a form element for selecting webform submission views replacement routes.

Plugin annotation

@FormElement("webform_submission_views_replace");

Hierarchy

Expanded class hierarchy of WebformSubmissionViewsReplace

2 #type uses of WebformSubmissionViewsReplace
WebformAdminConfigSubmissionsForm::buildForm in src/Form/AdminConfig/WebformAdminConfigSubmissionsForm.php
Form constructor.
WebformEntitySettingsSubmissionsForm::form in src/EntitySettings/WebformEntitySettingsSubmissionsForm.php
Gets the actual form array to be built.

File

src/Element/WebformSubmissionViewsReplace.php, line 14

Namespace

Drupal\webform\Element
View source 
class WebformSubmissionViewsReplace extends FormElement {

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

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input === FALSE) {
      if (!isset($element['#default_value'])) {
        $element['#default_value'] = [];
      }
      return $element['#default_value'];
    }
    else {
      return $input;
    }
  }

  /**
   * Processes a webform submission views replacement element.
   */
  public static function processWebformSubmissionViewsReplace(&$element, FormStateInterface $form_state, &$complete_form) {
    $is_global = !empty($element['#global']) ? TRUE : FALSE;
    $element['#tree'] = TRUE;
    $element['#value'] = !is_array($element['#value']) ? [] : $element['#value'];
    $element['#value'] += [
      'global_routes' => [],
      'webform_routes' => [],
      'node_routes' => [],
    ];

    // Global routes.
    if ($is_global) {
      $element['global_routes'] = [
        '#type' => 'checkboxes',
        '#title' => t('Replace the global results with submission views'),
        '#options' => [
          'entity.webform_submission.collection' => t('Submissions'),
          'entity.webform_submission.user' => t('User'),
        ],
        '#default_value' => $element['#value']['global_routes'],
        '#element_validate' => [
          [
            '\\Drupal\\webform\\Utility\\WebformElementHelper',
            'filterValues',
          ],
        ],
      ];
    }

    // Webform routes.
    $webform_routes_options = [
      'entity.webform.results_submissions' => t('Submissions'),
      'entity.webform.user.drafts' => t('User drafts'),
      'entity.webform.user.submissions' => t('User submissions'),
    ];
    if (!$is_global) {
      $default_webform_routes = \Drupal::configFactory()
        ->get('webform.settings')
        ->get('settings.default_submission_views_replace.webform_routes') ?: [];
      if ($webform_routes_options) {
        $webform_routes_options = array_diff_key($webform_routes_options, array_flip($default_webform_routes));
      }
    }
    $element['webform_routes'] = [
      '#type' => 'checkboxes',
      '#title' => t('Replace the webform results with submission views'),
      '#options' => $webform_routes_options,
      '#default_value' => $webform_routes_options ? $element['#value']['webform_routes'] : [],
      '#access' => $webform_routes_options ? TRUE : FALSE,
      '#element_validate' => [
        [
          '\\Drupal\\webform\\Utility\\WebformElementHelper',
          'filterValues',
        ],
      ],
    ];

    // Node routes.
    $node_routes_options = [
      'entity.node.webform.results_submissions' => t('Submissions'),
      'entity.node.webform.user.drafts' => t('User drafts'),
      'entity.node.webform.user.submissions' => t('User submissions'),
    ];
    if (!$is_global) {
      $default_node_routes = \Drupal::configFactory()
        ->get('webform.settings')
        ->get('settings.default_submission_views_replace.node_routes') ?: [];
      if ($default_node_routes) {
        $node_routes_options = array_diff_key($node_routes_options, array_flip($default_node_routes));
      }
    }
    $element['node_routes'] = [
      '#type' => 'checkboxes',
      '#title' => t('Replace the node results with submission views'),
      '#options' => $node_routes_options,
      '#default_value' => $node_routes_options ? $element['#value']['node_routes'] : [],
      '#access' => $node_routes_options && \Drupal::moduleHandler()
        ->moduleExists('webform_node') ? TRUE : FALSE,
      '#element_validate' => [
        [
          '\\Drupal\\webform\\Utility\\WebformElementHelper',
          'filterValues',
        ],
      ],
    ];

    // Add validate callback that extracts the array of items.
    $element += [
      '#element_validate' => [],
    ];
    array_unshift($element['#element_validate'], [
      get_called_class(),
      'validateWebformSubmissionViewsReplace',
    ]);
    return $element;
  }

  /**
   * Validates webform submission views replacement element.
   */
  public static function validateWebformSubmissionViewsReplace(&$element, FormStateInterface $form_state, &$complete_form) {
    $values = NestedArray::getValue($form_state
      ->getValues(), $element['#parents']);

    // Remove empty view replace references.
    if (empty($values['global_routes']) && empty($values['webform_routes']) && empty($values['node_routes'])) {
      $values = [];
    }
    $element['#value'] = $values;
    $form_state
      ->setValueForElement($element, $values);
  }

}

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.
WebformSubmissionViewsReplace::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
WebformSubmissionViewsReplace::processWebformSubmissionViewsReplace public static function Processes a webform submission views replacement element.
WebformSubmissionViewsReplace::validateWebformSubmissionViewsReplace public static function Validates webform submission views replacement element.
WebformSubmissionViewsReplace::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback