You are here

class WebformPermissions in Webform 8.5

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

Provides a webform roles (select) element.

Plugin annotation

@FormElement("webform_permissions");

Hierarchy

Expanded class hierarchy of WebformPermissions

2 #type uses of WebformPermissions
WebformElementBase::form in src/Plugin/WebformElementBase.php
Gets the actual configuration webform array to be built.
WebformEntitySettingsAccessForm::form in src/EntitySettings/WebformEntitySettingsAccessForm.php
Gets the actual form array to be built.

File

src/Element/WebformPermissions.php, line 14

Namespace

Drupal\webform\Element
View source
class WebformPermissions extends Select {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $info = parent::getInfo();
    $class = get_class($this);
    $info['#element_validate'] = [
      [
        $class,
        'validateWebformPermissions',
      ],
    ];
    return $info;
  }

  /**
   * Processes a webform roles (select) element.
   */
  public static function processSelect(&$element, FormStateInterface $form_state, &$complete_form) {

    /** @var \Drupal\user\PermissionHandlerInterface $permission_handler */
    $permission_handler = \Drupal::service('user.permissions');

    /** @var \Drupal\Core\Extension\ModuleHandlerInterface $module_handler */
    $module_handler = \Drupal::service('module_handler');

    // Get list of permissions as options.
    $options = [];
    $permissions = $permission_handler
      ->getPermissions();
    foreach ($permissions as $perm => $perm_item) {
      $provider = $perm_item['provider'];
      $display_name = $module_handler
        ->getName($provider);
      $options[$display_name][$perm] = strip_tags($perm_item['title']);
    }
    $element['#options'] = $options;
    $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 (select) element.
   */
  public static function validateWebformPermissions(&$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);
    }
  }

}

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.
WebformPermissions::getInfo public function Returns the element properties for this element. Overrides Select::getInfo
WebformPermissions::processSelect public static function Processes a webform roles (select) element. Overrides Select::processSelect
WebformPermissions::validateWebformPermissions public static function Webform element validation handler for webform roles (select) element.