You are here

Home » API reference » Multiselect 2.x » Multiselect.php

class Multiselect in Multiselect 2.x

Same name and namespace in other branches
  1. 8 src/Element/Multiselect.php \Drupal\multiselect\Element\Multiselect

Provides a form element for displaying the label for a form element.

Labels are generated automatically from element properties during processing of most form elements.

Plugin annotation

@FormElement("multiselect");

Hierarchy

Expanded class hierarchy of Multiselect

1 file declares its use of Multiselect
multiselect.module in ./multiselect.module
Select multiple items in an easier way than the normal node-reference widget.
4 string references to 'Multiselect'
multiselect.info.yml in ./multiselect.info.yml
multiselect.info.yml
multiselect.links.menu.yml in ./multiselect.links.menu.yml
multiselect.links.menu.yml
multiselect.links.task.yml in ./multiselect.links.task.yml
multiselect.links.task.yml
multiselect.routing.yml in ./multiselect.routing.yml
multiselect.routing.yml
2 #type uses of Multiselect
MultiselectTestForm::buildForm in tests/modules/multiselect_test/src/Form/MultiselectTestForm.php
Form constructor.
MultiselectWidget::formElement in src/Plugin/Field/FieldWidget/MultiselectWidget.php
Returns the form for a single field widget.

File

src/Element/Multiselect.php, line 15

Namespace

Drupal\multiselect\Element
View source 
class Multiselect extends Select {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#theme' => 'multiselect',
      '#input' => TRUE,
      '#multiple' => TRUE,
      '#process' => [
        [
          $class,
          'processSelect',
        ],
      ],
      '#default_value' => NULL,
      '#theme_wrappers' => [
        'form_element',
      ],
      '#attached' => [
        'library' => [
          'multiselect/drupal.multiselect',
        ],
      ],
    ];
  }

  /**
   * Helper function for get multiselect options.
   *
   * @param string $type
   *   The type of options.
   * @param array $element
   *   An associative array containing the properties of the element.
   * @param mixed $choices
   *   Mixed: Either an associative array of items to list as choices, or an
   *   object with an 'option' member that is an associative array. This
   *   parameter is only used internally and should not be passed.
   *
   * @return array
   *   An array of options for the multiselect form element.
   */
  public static function getOptions($type, array $element, $choices = NULL) {
    if (!isset($choices)) {
      if (empty($element['#options'])) {
        return [];
      }
      $choices = $element['#options'];
    }
    $options = [];

    // array_key_exists() accommodates the rare event where $element['#value']
    // is NULL. isset() fails in this situation.
    $value_valid = isset($element['#value']) || array_key_exists('#value', $element);
    $value_is_array = $value_valid && is_array($element['#value']);

    // Check if the element is multiple select and no value has been selected.
    $empty_value = empty($element['#value']) && !empty($element['#multiple']);
    foreach ($choices as $key => $choice) {
      if (is_array($choice)) {

        // @todo add support for optgroup.
        $options[] .= self::getOptions($type, $element, $choice);
      }
      elseif (is_object($choice) && isset($choice->option)) {
        $options[] .= self::getOptions($type, $element, $choice->option);
      }
      else {
        $key = (string) $key;
        $empty_choice = $empty_value && $key == '_none';
        switch ($type) {
          case 'available':
            if (!($value_valid && (!$value_is_array && (string) $element['#value'] === $key || $value_is_array && in_array($key, $element['#value']) || $empty_choice))) {
              $options[] = [
                'type' => 'option',
                'value' => $key,
                'label' => $choice,
              ];
            }
            break;
          case 'selected':
            if ($value_valid && (!$value_is_array && (string) $element['#value'] === $key || $value_is_array && in_array($key, $element['#value']) || $empty_choice)) {
              $options[] = [
                'type' => 'option',
                'value' => $key,
                'label' => $choice,
              ];
            }
            break;
        }
      }
    }
    return $options;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
Multiselect::getInfo public function Returns the element properties for this element. Overrides Select::getInfo
Multiselect::getOptions public static function Helper function for get multiselect options.
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
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
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. 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.