You are here

Home » API reference » Webform 8.5 » WebformExcludedElements.php

class WebformExcludedElements in Webform 8.5

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

Provides a webform element for webform excluded elements.

Plugin annotation

@FormElement("webform_excluded_elements");

Hierarchy

Expanded class hierarchy of WebformExcludedElements

3 #type uses of WebformExcludedElements
EmailWebformHandler::buildConfigurationForm in src/Plugin/WebformHandler/EmailWebformHandler.php
Form constructor.
WebformEntitySettingsFormForm::form in src/EntitySettings/WebformEntitySettingsFormForm.php
Gets the actual form array to be built.
WebformEntitySettingsSubmissionsForm::form in src/EntitySettings/WebformEntitySettingsSubmissionsForm.php
Gets the actual form array to be built.

File

src/Element/WebformExcludedElements.php, line 15

Namespace

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

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return parent::getInfo() + [
      '#exclude_markup' => TRUE,
    ];
  }

  /**
   * Get header for the excluded tableselect element.
   *
   * @return array
   *   An array container the header for the excluded tableselect element.
   */
  public static function getWebformExcludedHeader() {
    $header = [];
    $header['title'] = [
      'data' => t('Title'),
    ];
    $header['key'] = [
      'data' => t('Key'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    $header['type'] = [
      'data' => t('Type'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    $header['private'] = [
      'data' => t('Private'),
    ];
    $header['access'] = [
      'data' => t('Access'),
    ];
    return $header;
  }

  /**
   * Get options for excluded tableselect element.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   generic element element.
   *
   * @return array
   *   An array of options containing title, name, and type of items for a
   *   tableselect element.
   */
  public static function getWebformExcludedOptions(array $element) {

    /** @var \Drupal\webform\Plugin\WebformElementManagerInterface $element_manager */
    $element_manager = \Drupal::service('plugin.manager.webform.element');

    /** @var \Drupal\webform\WebformInterface $webform */
    $webform = WebformEntity::load($element['#webform_id']) ?: \Drupal::service('webform.request')
      ->getCurrentWebform();
    $options = [];
    if ($element['#exclude_markup']) {
      $form_elements = $webform
        ->getElementsInitializedFlattenedAndHasValue();
    }
    else {
      $form_elements = $webform
        ->getElementsInitializedAndFlattened();
    }
    foreach ($form_elements as $key => $form_element) {
      $form_element_plugin = $element_manager
        ->getElementInstance($form_element);

      // Skip markup elements that are containers or actions.
      if (!$element['#exclude_markup'] && ($form_element_plugin
        ->isContainer($form_element) || $form_element_plugin instanceof WebformActionsWebformElement)) {
        continue;
      }
      if (!empty($form_element['#access_view_roles'])) {
        $roles = array_map(function ($item) {
          return $item
            ->label();
        }, Role::loadMultiple($form_element['#access_view_roles']));
      }
      else {
        $roles = [];
      }
      $options[$key] = [
        'title' => $form_element['#admin_title'] ?: $form_element['#title'] ?: $key,
        'key' => $key,
        'type' => isset($form_element['#type']) ? $form_element['#type'] : '',
        'private' => empty($form_element['#private']) ? t('No') : t('Yes'),
        'access' => $roles ? WebformArrayHelper::toString($roles) : t('All roles'),
      ];
      if (!empty($form_element['#private']) || $roles) {
        $options[$key]['#attributes']['class'][] = 'color-warning';
      }
    }
    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::processWebformExcluded public static function Processes a webform elements webform element.
WebformExcludedBase::validateWebformExcluded public static function Validates a tablelselect element.
WebformExcludedElements::getInfo public function Returns the element properties for this element. Overrides WebformExcludedBase::getInfo
WebformExcludedElements::getWebformExcludedHeader public static function Get header for the excluded tableselect element. Overrides WebformExcludedBase::getWebformExcludedHeader
WebformExcludedElements::getWebformExcludedOptions public static function Get options for excluded tableselect element. Overrides WebformExcludedBase::getWebformExcludedOptions