You are here

Home » API reference » YAML Form 8 » YamlFormRoles.php

class YamlFormRoles in YAML Form 8

Provides a roles entity reference form element.

Plugin annotation

@FormElement("yamlform_roles");

Hierarchy

Expanded class hierarchy of YamlFormRoles

2 #type uses of YamlFormRoles
YamlFormElementBase::form in src/YamlFormElementBase.php
Gets the actual configuration form array to be built.
YamlFormEntityAccessForm::form in src/YamlFormEntityAccessForm.php
Gets the actual form array to be built.

File

src/Element/YamlFormRoles.php, line 13

Namespace

Drupal\yamlform\Element
View source 
class YamlFormRoles extends Checkboxes {

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

  /**
   * Processes a checkboxes form element.
   */
  public static function processCheckboxes(&$element, FormStateInterface $form_state, &$complete_form) {
    $element['#options'] = array_map('\\Drupal\\Component\\Utility\\Html::escape', user_role_names());

    // Check if anonymous is included.
    if (empty($element['#include_anonymous'])) {
      unset($element['#options']['anonymous']);
    }
    $element['#attached']['library'][] = 'yamlform/yamlform.element.roles';
    $element['#attributes']['class'][] = 'js-yamlform-roles-role';
    return parent::processCheckboxes($element, $form_state, $complete_form);
  }

  /**
   * Form element validation handler for yamlform_users elements.
   */
  public static function validateYamlFormRoles(array &$element, FormStateInterface $form_state, array &$complete_form) {
    $value = $form_state
      ->getValue($element['#parents'], []);
    $form_state
      ->setValueForElement($element, array_values(array_filter($value)));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Checkboxes::detectEmptyCheckboxes public static function Determines if all checkboxes in a set are unchecked.
Checkboxes::getCheckedCheckboxes public static function Determines which checkboxes were checked when a form is submitted.
Checkboxes::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
CompositeFormElementTrait::preRenderCompositeFormElement public static function Adds form element theming to an element if its title or description is set.
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.
YamlFormRoles::getInfo public function Returns the element properties for this element. Overrides Checkboxes::getInfo
YamlFormRoles::processCheckboxes public static function Processes a checkboxes form element. Overrides Checkboxes::processCheckboxes
YamlFormRoles::validateYamlFormRoles public static function Form element validation handler for yamlform_users elements.