You are here

class Buttons in Select (or other) 8

Same name and namespace in other branches
  1. 8.3 src/Element/Buttons.php \Drupal\select_or_other\Element\Buttons
  2. 4.x src/Element/Buttons.php \Drupal\select_or_other\Element\Buttons

Provides a form element with buttons and other option.

Plugin annotation

@FormElement("select_or_other_buttons");

Hierarchy

Expanded class hierarchy of Buttons

See also

ElementBase

1 file declares its use of Buttons
ButtonsElementTest.php in tests/src/Unit/ButtonsElementTest.php

File

src/Element/Buttons.php, line 14

Namespace

Drupal\select_or_other\Element
View source
class Buttons extends ElementBase {

  /**
   * {@inheritdoc}
   */
  public static function processSelectOrOther(&$element, FormStateInterface $form_state, &$complete_form) {
    $element = parent::processSelectOrOther($element, $form_state, $complete_form);
    static::setSelectType($element);
    static::addStatesHandling($element);
    static::addEmptyOption($element);
    return $element;
  }

  /**
   * Sets the type of buttons to use for the select element.
   *
   * @param array $element
   *   The select or other element.
   */
  protected static function setSelectType(array &$element) {
    if ($element['#multiple']) {
      $element['select']['#type'] = 'checkboxes';
    }
    else {
      $element['select']['#type'] = 'radios';
      static::ensureCorrectDefaultValue($element);
    }
  }

  /**
   * Ensures the element has the correct default value.
   *
   * @param array $element
   *   The select or other element.
   */
  protected static function ensureCorrectDefaultValue(array &$element) {
    if ($element['select']['#type'] === 'radios') {

      // Radio buttons do not accept an array as default value.
      if (!empty($element['select']['#default_value']) && is_array($element['select']['#default_value'])) {
        $element['select']['#default_value'] = reset($element['select']['#default_value']);
      }
    }
  }

  /**
   * Adds a #states array to the other field to make hide/show work.
   *
   * @param array $element
   *   The select or other element.
   */
  protected static function addStatesHandling(array &$element) {
    if (!$element['#multiple']) {
      $element['other']['#states'] = static::prepareState('visible', $element['#name'] . '[select]', 'value', 'select_or_other');
    }
    else {
      $element['other']['#states'] = static::prepareState('visible', $element['#name'] . '[select][select_or_other]', 'checked', TRUE);
    }
  }

  /**
   * Adds an empty option to the select element if required.
   *
   * @param array $element
   *   The select or other element.
   */
  protected static function addEmptyOption(array &$element) {
    if (!isset($element['#no_empty_option']) || !$element['#no_empty_option']) {
      if (!$element['#multiple'] && !$element['#required'] && !empty($element['#default_value'])) {
        $element['select']['#options'] = [
          '' => t('- None -'),
        ] + $element['select']['#options'];
      }
      else {
        $element['select']['#value'] = [];
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Buttons::addEmptyOption protected static function Adds an empty option to the select element if required.
Buttons::addStatesHandling protected static function Adds a #states array to the other field to make hide/show work.
Buttons::ensureCorrectDefaultValue protected static function Ensures the element has the correct default value.
Buttons::processSelectOrOther public static function Render API callback: Expands the select_or_other element type. Overrides ElementBase::processSelectOrOther
Buttons::setSelectType protected static function Sets the type of buttons to use for the select element.
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
ElementBase::addOtherField protected static function Adds the 'other' field to the element.
ElementBase::addOtherOption protected static function Adds an 'other' option to the selectbox.
ElementBase::addSelectField protected static function Adds the 'select' field to the element.
ElementBase::elementIsDisabled private static function
ElementBase::getInfo public function @codeCoverageIgnore Overrides ElementInterface::getInfo
ElementBase::noElementAccess private static function
ElementBase::prepareState protected static function Prepares an array to be used as a state in a form API #states array.
ElementBase::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
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.