You are here

Home » API reference » Webform 8.5 » WebformExcludedColumns.php

class WebformExcludedColumns in Webform 8.5

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

Provides a webform element for webform excluded columns (submission field and elements).

Plugin annotation

@FormElement("webform_excluded_columns");

Hierarchy

Expanded class hierarchy of WebformExcludedColumns

2 #type uses of WebformExcludedColumns
RemotePostWebformHandler::buildConfigurationForm in src/Plugin/WebformHandler/RemotePostWebformHandler.php
Form constructor.
WebformSubmissionExporter::buildExportOptionsForm in src/WebformSubmissionExporter.php
Build export options webform.

File

src/Element/WebformExcludedColumns.php, line 12

Namespace

Drupal\webform\Element
View source 
class WebformExcludedColumns extends WebformExcludedBase {

  /**
   * {@inheritdoc}
   */
  public static function getWebformExcludedHeader() {
    return [
      'title' => t('Title'),
      'name' => t('Name'),
      'type' => t('Date type/Element type'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function getWebformExcludedOptions(array $element) {

    /** @var \Drupal\webform\WebformInterface $webform */
    $webform = WebformEntity::load($element['#webform_id']) ?: \Drupal::service('webform.request')
      ->getCurrentWebform();
    if (!$webform) {
      return [];
    }
    $options = [];

    /** @var \Drupal\webform\WebformSubmissionStorageInterface $submission_storage */
    $submission_storage = \Drupal::entityTypeManager()
      ->getStorage('webform_submission');
    $field_definitions = $submission_storage
      ->getFieldDefinitions();
    $field_definitions = $submission_storage
      ->checkFieldDefinitionAccess($webform, $field_definitions);
    foreach ($field_definitions as $key => $field_definition) {
      $options[$key] = [
        'title' => $field_definition['title'],
        'name' => $key,
        'type' => $field_definition['type'],
      ];
    }
    $elements = $webform
      ->getElementsInitializedFlattenedAndHasValue('view');

    // Replace tokens which can be used in an element's #title.

    /** @var \Drupal\webform\WebformTokenManagerInterface $token_manager */
    $token_manager = \Drupal::service('webform.token_manager');
    $elements = $token_manager
      ->replace($elements, $webform);
    foreach ($elements as $key => $element) {
      $options[$key] = [
        'title' => $element['#admin_title'] ?: $element['#title'] ?: $key,
        'name' => $key,
        'type' => isset($element['#type']) ? $element['#type'] : '',
      ];
    }
    return $options;
  }

}

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.
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 15
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.
WebformExcludedBase::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo 1
WebformExcludedBase::processWebformExcluded public static function Processes a webform elements webform element.
WebformExcludedBase::validateWebformExcluded public static function Validates a tablelselect element.
WebformExcludedColumns::getWebformExcludedHeader public static function Get header for the excluded tableselect element. Overrides WebformExcludedBase::getWebformExcludedHeader
WebformExcludedColumns::getWebformExcludedOptions public static function Get options for excluded tableselect element. Overrides WebformExcludedBase::getWebformExcludedOptions