class Select in Zircon Profile 8

Provides a form element for a drop-down menu or scrolling selection box.

Properties:

• #options: An associative array, where the keys are the retured values for each option, and the values are the options to be shown in the drop-down list.
• #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.

Plugin annotation

@FormElement("select");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
        • class \Drupal\Core\Render\Element\Select

5 string references to 'Select'

Connection::select in core/lib/Drupal/Core/Database/Connection.php

Prepares and returns a SELECT query object.

ConnectionTest::providerGetDriverClass in core/tests/Drupal/Tests/Core/Database/ConnectionTest.php

Dataprovider for testGetDriverClass().

FilterPluginBase::buildExposedFiltersGroupForm in core/modules/views/src/Plugin/views/filter/FilterPluginBase.php

Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group'

FormTestValidateRequiredForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestValidateRequiredForm.php

Form constructor.

form_test.routing.yml in core/modules/system/tests/modules/form_test/form_test.routing.yml

core/modules/system/tests/modules/form_test/form_test.routing.yml

150 #type uses of Select

AccountSettingsForm::buildForm in core/modules/user/src/AccountSettingsForm.php

Form constructor.

ActionAdminManageForm::buildForm in core/modules/action/src/Form/ActionAdminManageForm.php

Form constructor.

AddHandler::buildForm in core/modules/views_ui/src/Form/Ajax/AddHandler.php

Form constructor.

AggregatorFeedBlock::blockForm in core/modules/aggregator/src/Plugin/Block/AggregatorFeedBlock.php

Returns the configuration form elements specific to this block plugin.

AjaxFormBlock::buildForm in core/modules/system/tests/modules/ajax_forms_test/src/Plugin/Block/AjaxFormBlock.php

Form constructor.

... See full list

File

core/lib/Drupal/Core/Render/Element/Select.php, line 25

Contains \Drupal\Core\Render\Element\Select.

Namespace

Drupal\Core\Render\Element

class Select extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return array(
      '#input' => TRUE,
      '#multiple' => FALSE,
      '#process' => array(
        array(
          $class,
          'processSelect',
        ),
        array(
          $class,
          'processAjaxForm',
        ),
      ),
      '#pre_render' => array(
        array(
          $class,
          'preRenderSelect',
        ),
      ),
      '#theme' => 'select',
      '#theme_wrappers' => array(
        'form_element',
      ),
      '#options' => array(),
    );
  }

  /**
   * Processes a select list form element.
   *
   * This process callback is mandatory for select fields, since all user agents
   * automatically preselect the first available option of single (non-multiple)
   * select lists.
   *
   * @param array $element
   *   The form element to process. Properties used:
   *   - #multiple: (optional) Indicates whether one or more options can be
   *     selected. Defaults to FALSE.
   *   - #default_value: Must be NULL or not set in case there is no value for the
   *     element yet, in which case a first default option is inserted by default.
   *     Whether this first option is a valid option depends on whether the field
   *     is #required or not.
   *   - #required: (optional) Whether the user needs to select an option (TRUE)
   *     or not (FALSE). Defaults to FALSE.
   *   - #empty_option: (optional) The label to show for the first default option.
   *     By default, the label is automatically set to "- Select -" for a required
   *     field and "- None -" for an optional field.
   *   - #empty_value: (optional) The value for the first default option, which is
   *     used to determine whether the user submitted a value or not.
   *     - If #required is TRUE, this defaults to '' (an empty string).
   *     - If #required is not TRUE and this value isn't set, then no extra option
   *       is added to the select control, leaving the control in a slightly
   *       illogical state, because there's no way for the user to select nothing,
   *       since all user agents automatically preselect the first available
   *       option. But people are used to this being the behavior of select
   *       controls.
   *       @todo Address the above issue in Drupal 8.
   *     - If #required is not TRUE and this value is set (most commonly to an
   *       empty string), then an extra option (see #empty_option above)
   *       representing a "non-selection" is added with this as its value.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The processed element.
   *
   * @see _form_validate()
   */
  public static function processSelect(&$element, FormStateInterface $form_state, &$complete_form) {

    // #multiple select fields need a special #name.
    if ($element['#multiple']) {
      $element['#attributes']['multiple'] = 'multiple';
      $element['#attributes']['name'] = $element['#name'] . '[]';
    }
    else {

      // If the element is set to #required through #states, override the
      // element's #required setting.
      $required = isset($element['#states']['required']) ? TRUE : $element['#required'];

      // If the element is required and there is no #default_value, then add an
      // empty option that will fail validation, so that the user is required to
      // make a choice. Also, if there's a value for #empty_value or
      // #empty_option, then add an option that represents emptiness.
      if ($required && !isset($element['#default_value']) || isset($element['#empty_value']) || isset($element['#empty_option'])) {
        $element += array(
          '#empty_value' => '',
          '#empty_option' => $required ? t('- Select -') : t('- None -'),
        );

        // The empty option is prepended to #options and purposively not merged
        // to prevent another option in #options mistakenly using the same value
        // as #empty_value.
        $empty_option = array(
          $element['#empty_value'] => $element['#empty_option'],
        );
        $element['#options'] = $empty_option + $element['#options'];
      }
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input !== FALSE) {
      if (isset($element['#multiple']) && $element['#multiple']) {

        // If an enabled multi-select submits NULL, it means all items are
        // unselected. A disabled multi-select always submits NULL, and the
        // default value should be used.
        if (empty($element['#disabled'])) {
          return is_array($input) ? array_combine($input, $input) : array();
        }
        else {
          return isset($element['#default_value']) && is_array($element['#default_value']) ? $element['#default_value'] : array();
        }
      }
      elseif (isset($element['#empty_value']) && $input === (string) $element['#empty_value']) {
        return $element['#empty_value'];
      }
      else {
        return $input;
      }
    }
  }

  /**
   * Prepares a select render element.
   */
  public static function preRenderSelect($element) {
    Element::setAttributes($element, array(
      'id',
      'name',
      'size',
    ));
    static::setAttributes($element, array(
      'form-select',
    ));
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
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
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object.	69
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.
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::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
Select::preRenderSelect	public static	function	Prepares a select render element.
Select::processSelect	public static	function	Processes a select list form 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.
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.