abstract class ElementBase in Select (or other) 8.3

Same name and namespace in other branches

8 src/Element/ElementBase.php \Drupal\select_or_other\Element\ElementBase
4.x src/Element/ElementBase.php \Drupal\select_or_other\Element\ElementBase

Base class for select or other form elements.

Properties:

#multiple: If the widget should allow multiple values to be selected.
#select_type: Either 'list' for a select list and 'buttons' for checkboxes or radio buttons depending on cardinality.
#merged_values: Set this to true if the widget should return a single array with the merged values from both the 'select' and 'other' fields.
#options: An associative array, where the keys are the retured values for each option, and the values are the options to be presented to the user.
#empty_option: The label that will be displayed to denote no selection.
#empty_value: The value of the option that is used to denote no selection.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
    class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
    class \Drupal\select_or_other\Element\ElementBase

Expanded class hierarchy of ElementBase

1 file declares its use of ElementBase

ElementsTest.php in Tests/src/Unit/ElementsTest.php

File

src/Element/ElementBase.php, line 27: Contains Drupal\select_or_other\Element\ElementBase.

Namespace

Drupal\select_or_other\Element

View source

abstract class ElementBase extends FormElement {

  /**
   * Adds an 'other' option to the selectbox.
   */
  protected static function addOtherOption($options) {
    $options['select_or_other'] = 'Other';
    return $options;
  }

  /**
   * Prepares a form API #states array.
   * @param $state
   * @param $elementName
   * @param $valueKey
   * @param $value
   * @return array
   */
  protected static function prepareStates($state, $elementName, $valueKey, $value) {
    return [
      $state => [
        ':input[name="' . $elementName . '"]' => [
          $valueKey => $value,
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   * @codeCoverageIgnore
   */
  public function getInfo() {
    $class = get_class($this);
    return array(
      '#input' => TRUE,
      '#process' => [
        [
          $class,
          'processSelectOrOther',
        ],
      ],
      '#multiple' => FALSE,
      '#select_type' => 'list',
      '#merged_values' => FALSE,
      '#theme_wrappers' => [
        'form_element',
      ],
      '#options' => [],
      '#tree' => TRUE,
    );
  }

  /**
   * Render API callback: Expands the select_or_other element type.
   *
   * Expands the select or other element to have a 'select' and 'other' field.
   */
  public static function processSelectOrOther(&$element, FormStateInterface $form_state, &$complete_form) {
    $element['select'] = [
      '#default_value' => $element['#default_value'],
      '#required' => $element['#required'],
      '#multiple' => $element['#multiple'],
      '#options' => ElementBase::addOtherOption($element['#options']),
      '#weight' => 10,
    ];

    // Create the 'other' textfield.
    $element['other'] = [
      '#type' => 'textfield',
      '#weight' => 20,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    $values = [];
    if ($input !== FALSE && !empty($input['select'])) {
      if ($element['#multiple']) {
        $values = [
          'select' => (array) $input['select'],
          'other' => !empty($input['other']) ? (array) $input['other'] : [],
        ];
        if (in_array('select_or_other', $values['select'])) {
          $values['select'] = array_diff($values['select'], [
            'select_or_other',
          ]);
        }
        else {
          $values['other'] = [];
        }
        if (isset($element['#merged_values']) && $element['#merged_values']) {
          if (!empty($values['other'])) {
            $values = array_merge($values['select'], $values['other']);

            // Add the other option to the available options to prevent
            // validation errors.
            $element['#options'][$input['other']] = $input['other'];
          }
          else {
            $values = $values['select'];
          }
        }
      }
      else {
        if ($input['select'] === 'select_or_other') {
          $values = [
            $input['other'],
          ];

          // Add the other option to the available options to prevent
          // validation errors.
          $element['#options'][$input['other']] = $input['other'];
        }
        else {
          $values = [
            $input['select'],
          ];
        }
      }
    }
    return $values;
  }

}

Members

Name	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
ElementBase::addOtherOption	protected static	function	Adds an 'other' option to the selectbox.
ElementBase::getInfo	public	function	@codeCoverageIgnore Overrides ElementInterface::getInfo
ElementBase::prepareStates	protected static	function	Prepares a form API #states array.
ElementBase::processSelectOrOther	public static	function	Render API callback: Expands the select_or_other element type.	2
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.

You are here

abstract class ElementBase in Select (or other) 8.3

Hierarchy

File

Namespace

Members

API Navigation