class SynonymsEntitySelect in Synonyms 8

Form element for synonyms-friendly entity select.

Plugin annotation

@FormElement("synonyms_entity_select");

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\Core\Render\Element\Select
    class \Drupal\synonyms\Element\SynonymsEntitySelect

Expanded class hierarchy of SynonymsEntitySelect

2 #type uses of SynonymsEntitySelect

EntityReferenceSynonymsSelect::formElement in src/Plugin/Field/FieldWidget/EntityReferenceSynonymsSelect.php: Returns the form for a single field widget.
SynonymsEntity::valueForm in synonyms_views_filter/src/Plugin/views/filter/SynonymsEntity.php: Options form subform for setting options.

File

src/Element/SynonymsEntitySelect.php, line 13

Namespace

Drupal\synonyms\Element

View source

class SynonymsEntitySelect extends Select {

  /**
   * Delimiter to use when separating entity ID and its synonym.
   *
   * @var string
   */
  const DELIMITER = ':';

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $info = parent::getInfo();
    array_unshift($info['#process'], [
      get_class($this),
      'elementSynonymsEntitySelect',
    ]);
    $info['#element_validate'][] = [
      get_class($this),
      'validateEntitySelect',
    ];
    return $info;
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    $return = parent::valueCallback($element, $input, $form_state);
    if (is_null($return) && isset($element['#default_value'])) {
      $return = $element['#default_value'];
    }

    // Force default value (entity ID(-s)) to be strings. Otherwise we are
    // hitting the situation when all synonyms are highlighted as selected.
    // This code snippet explains the problem:
    // $a = [25];
    // $k = '25:25';
    // in_array($k, $a); // Yields TRUE, because PHP seems to compare
    // int to int and not string-wise.
    if (is_array($return)) {
      $return = array_map(function ($item) {
        return (string) $item;
      }, $return);
    }
    elseif (!is_null($return)) {
      $return = (string) $return;
    }
    return $return;
  }

  /**
   * Form element process callback for 'synonyms_entity_select' type.
   */
  public static function elementSynonymsEntitySelect(array &$element, FormStateInterface $form_state, array &$complete_form) {
    $options = [];
    $selection = \Drupal::service('plugin.manager.entity_reference_selection')
      ->getInstance([
      'target_type' => $element['#target_type'],
      'target_bundles' => $element['#target_bundles'],
      'entity' => NULL,
    ]);
    $bundle_info = \Drupal::getContainer()
      ->get('entity_type.bundle.info')
      ->getBundleInfo($element['#target_type']);
    $referenceable_entities = $selection
      ->getReferenceableEntities();
    $entities = [];
    foreach ($referenceable_entities as $bundle_entity_ids) {
      $entities = array_merge($entities, array_keys($bundle_entity_ids));
    }
    if (!empty($entities)) {
      $entities = \Drupal::entityTypeManager()
        ->getStorage($element['#target_type'])
        ->loadMultiple($entities);
    }
    foreach ($referenceable_entities as $bundle => $entity_ids) {
      $synonyms = \Drupal::getContainer()
        ->get('synonyms.behavior.select')
        ->getSynonymsMultiple(array_intersect_key($entities, $entity_ids));
      foreach ($entity_ids as $entity_id => $label) {
        $options[$entity_id] = $label;
        foreach ($synonyms[$entity_id] as $synonym) {
          $options[$entity_id . self::DELIMITER . $synonym['synonym']] = $synonym['wording'];
        }
      }
    }
    $element['#options'] = $options;
    return $element;
  }

  /**
   * Form element validation handler for synonyms_entity_select elements.
   */
  public static function validateEntitySelect(array &$element, FormStateInterface $form_state, array &$complete_form) {
    $value = $form_state
      ->getValue($element['#parents']);
    if (!isset($element['#multiple']) || !$element['#multiple']) {
      $value = [
        $value,
      ];
    }
    $unique = [];
    foreach ($value as $v) {
      if (!empty($v)) {
        if (!is_numeric($v)) {
          $v = explode(self::DELIMITER, $v, 2)[0];
        }
        $unique[$v] = $v;
      }
    }
    $items = [];
    foreach ($unique as $v) {
      $items[] = [
        $element['#key_column'] => $v,
      ];
    }
    if (!isset($element['#multiple']) || !$element['#multiple']) {
      $items = reset($items);
    }
    $form_state
      ->setValueForElement($element, $items);
  }

}

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
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
Select::preRenderSelect	public static	function	Prepares a select render element.
Select::processSelect	public static	function	Processes a select list form element.
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.
SynonymsEntitySelect::DELIMITER		constant	Delimiter to use when separating entity ID and its synonym.
SynonymsEntitySelect::elementSynonymsEntitySelect	public static	function	Form element process callback for 'synonyms_entity_select' type.
SynonymsEntitySelect::getInfo	public	function	Returns the element properties for this element. Overrides Select::getInfo
SynonymsEntitySelect::validateEntitySelect	public static	function	Form element validation handler for synonyms_entity_select elements.
SynonymsEntitySelect::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides Select::valueCallback

You are here

class SynonymsEntitySelect in Synonyms 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation