You are here

class WebformScale in Webform 6.x

Same name in this branch
  1. 6.x src/Element/WebformScale.php \Drupal\webform\Element\WebformScale
  2. 6.x src/Plugin/WebformElement/WebformScale.php \Drupal\webform\Plugin\WebformElement\WebformScale
Same name and namespace in other branches
  1. 8.5 src/Element/WebformScale.php \Drupal\webform\Element\WebformScale

Provides a webform element for a scale (1-5).

Plugin annotation

@FormElement("webform_scale");

Hierarchy

Expanded class hierarchy of WebformScale

File

src/Element/WebformScale.php, line 14

Namespace

Drupal\webform\Element
View source
class WebformScale extends Radios {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    return parent::getInfo() + [
      '#min' => 1,
      '#max' => 5,
      '#min_text' => '',
      '#max_text' => '',
      '#scale_size' => 'medium',
      '#scale_type' => 'circle',
      '#scale_text' => 'below',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function processRadios(&$element, FormStateInterface $form_state, &$complete_form) {

    // Add text.
    $scale_text = [];
    if ($element['#min_text'] || $element['#max_text']) {
      $classes = [
        'webform-scale-text',
        'webform-scale-text-' . $element['#scale_text'],
      ];
      $scale_text = [
        '#prefix' => '<div class="' . implode(' ', $classes) . '">',
        '#suffix' => '</div>',
      ];
      if ($element['#min_text']) {
        $scale_text['min'] = [
          '#markup' => $element['#min_text'],
          '#prefix' => '<div class="webform-scale-text-min">',
          '#suffix' => '</div>',
        ];
      }
      if ($element['#max_text']) {
        $scale_text['max'] = [
          '#prefix' => '<div class="webform-scale-text-max">',
          '#suffix' => '</div>',
          '#markup' => $element['#max_text'],
        ];
      }
    }

    // Scale.
    $classes = [
      'webform-scale',
      'webform-scale-' . $element['#scale_type'],
      'webform-scale-' . $element['#scale_size'],
      'webform-scale-' . $element['#min'] . '-to-' . $element['#max'],
    ];
    $element['scale'] = [
      '#prefix' => '<div class="' . implode(' ', $classes) . '">',
      '#suffix' => '</div>',
    ];

    // Text above.
    if ($scale_text && $element['#scale_text'] === 'above') {
      $element['scale']['text'] = $scale_text;
    }

    // Options.
    $element['scale']['options'] = [
      '#prefix' => '<div class="webform-scale-options">',
      '#suffix' => '</div>',
    ];
    $ratings = range($element['#min'], $element['#max']);
    $element['#options'] = array_combine($ratings, $ratings);
    foreach ($element['#options'] as $key => $choice) {
      $parents_for_id = array_merge($element['#parents'], [
        $key,
      ]);
      $element['scale']['options'] += [
        $key => [],
      ];
      $element['scale']['options'][$key] += [
        '#type' => 'radio',
        '#title' => $choice,
        '#return_value' => $key,
        '#default_value' => isset($element['#default_value']) ? $element['#default_value'] : FALSE,
        '#attributes' => $element['#attributes'],
        '#parents' => $element['#parents'],
        '#id' => HtmlUtility::getUniqueId('edit-' . implode('-', $parents_for_id)),
        '#ajax' => isset($element['#ajax']) ? $element['#ajax'] : NULL,
        '#error_no_message' => TRUE,
        '#prefix' => '<div class="webform-scale-option">',
        '#suffix' => '</div>',
      ];

      // Add .webform-scale-N class to the radio.
      $element['scale']['options'][$key]['#attributes']['class'][] = 'webform-scale-' . $key;

      // Add .visually-hidden class to the radio.
      $element['scale']['options'][$key]['#attributes']['class'][] = 'visually-hidden';
    }

    // Text below.
    if ($scale_text && $element['#scale_text'] === 'below') {
      $element['scale']['text'] = $scale_text;
    }

    // Add scale library.
    $element['#attached']['library'][] = 'webform/webform.element.scale';
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CompositeFormElementTrait::preRenderCompositeFormElement public static function Adds form element theming to an element if its title or description is set.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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. 98
Radios::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
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. 4
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.
WebformScale::getInfo public function Returns the element properties for this element. Overrides Radios::getInfo
WebformScale::processRadios public static function Expands a radios element into individual radio elements. Overrides Radios::processRadios