You are here

class WebformGroupRoles in Webform 8.5

Same name and namespace in other branches
  1. 6.x modules/webform_group/src/Element/WebformGroupRoles.php \Drupal\webform_group\Element\WebformGroupRoles

Provides a webform group roles element.

Plugin annotation

@FormElement("webform_group_roles");

Hierarchy

Expanded class hierarchy of WebformGroupRoles

1 file declares its use of WebformGroupRoles
WebformGroupRolesElementTest.php in modules/webform_group/tests/src/Functional/WebformGroupRolesElementTest.php
3 #type uses of WebformGroupRoles
webform_group_form_webform_admin_config_handlers_form_alter in modules/webform_group/webform_group.module
Implements hook_form_FORM_ID_alter() for webform admin config handlers form.
webform_group_form_webform_settings_access_form_alter in modules/webform_group/webform_group.module
Implements hook_form_FORM_ID_alter() for webform settings access form.
webform_group_form_webform_ui_element_form_alter in modules/webform_group/webform_group.module
Implements hook_form_FORM_ID_alter() for webform ui element form.

File

modules/webform_group/src/Element/WebformGroupRoles.php, line 15

Namespace

Drupal\webform_group\Element
View source
class WebformGroupRoles extends Select {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    $info = parent::getInfo();
    $info['#element_validate'] = [
      [
        $class,
        'validateWebformGroupRoles',
      ],
    ];
    $info['#include_internal'] = TRUE;
    $info['#include_user_roles'] = FALSE;
    $info['#include_anonymous'] = FALSE;
    $info['#include_outsider'] = TRUE;
    $info['#multiple'] = TRUE;
    return $info;
  }

  /**
   * Processes a webform roles (checkboxes) element.
   */
  public static function processSelect(&$element, FormStateInterface $form_state, &$complete_form) {
    $element['#options'] = static::getGroupRolesOptions($element);
    $element['#select2'] = TRUE;

    // Must convert this element['#type'] to a 'select' to prevent
    // "Illegal choice %choice in %name element" validation error.
    // @see \Drupal\Core\Form\FormValidator::performRequiredValidation
    $element['#type'] = 'select';
    WebformElementHelper::process($element);
    return parent::processSelect($element, $form_state, $complete_form);
  }

  /**
   * Webform element validation handler for webform roles (checkboxes) element.
   */
  public static function validateWebformGroupRoles(&$element, FormStateInterface $form_state, &$complete_form) {
    if (!empty($element['#multiple'])) {
      $value = array_values($form_state
        ->getValue($element['#parents'], []));
      $element['#value'] = $value;
      $form_state
        ->setValueForElement($element, $value);
    }
  }

  /**
   * Get group roles options for an element.
   *
   * @param array $element
   *   An element.
   *
   * @return array
   *   Group roles options for an element.
   */
  public static function getGroupRolesOptions(array $element) {
    $element += [
      '#include_internal' => TRUE,
      '#include_user_roles' => FALSE,
      '#include_anonymous' => FALSE,
      '#include_outsider' => TRUE,
    ];

    /** @var \Drupal\group\Entity\GroupRoleInterface[] $group_roles */
    $group_roles = GroupRole::loadMultiple();
    $group_role_names = [];
    $options = [];
    foreach ($group_roles as $group_role) {
      if (!$element['#include_internal'] && $group_role
        ->isInternal()) {
        continue;
      }
      if (!$element['#include_user_roles'] && !$group_role
        ->inPermissionsUI()) {
        continue;
      }
      if (!$element['#include_anonymous'] && $group_role
        ->isAnonymous()) {
        continue;
      }
      if (!$element['#include_outsider'] && $group_role
        ->isOutsider()) {
        continue;
      }
      $group_role_id = $group_role
        ->id();
      $group_role_label = $group_role
        ->label();
      $group_type = $group_role
        ->getGroupType();
      $group_type_id = $group_type
        ->id();
      $group_type_label = $group_type
        ->label();
      $t_args = [
        '@group_type' => $group_type_label,
        '@group_role' => $group_role_label,
      ];
      $options[$group_type_label][$group_role_id] = t('@group_type: @group_role', $t_args);
      $group_role_name = preg_replace("/^{$group_type_id}-/", "", $group_role_id);
      $group_role_names[$group_role_name] = $group_role_label;
    }
    ksort($options);
    return [
      (string) t('Group role types') => $group_role_names,
    ] + $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.
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
Select::preRenderSelect public static function Prepares a select render element.
Select::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
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.
WebformGroupRoles::getGroupRolesOptions public static function Get group roles options for an element.
WebformGroupRoles::getInfo public function Returns the element properties for this element. Overrides Select::getInfo
WebformGroupRoles::processSelect public static function Processes a webform roles (checkboxes) element. Overrides Select::processSelect
WebformGroupRoles::validateWebformGroupRoles public static function Webform element validation handler for webform roles (checkboxes) element.