class SocialGroupEntityAutocomplete in Open Social 8.9

Provides an Group member autocomplete form element.

The #default_value accepted by this element is either an entity object or an array of entity objects.

Plugin annotation

@FormElement("social_group_entity_autocomplete");

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\Textfield
          • class \Drupal\Core\Entity\Element\EntityAutocomplete
            • class \Drupal\social_core\Entity\Element\EntityAutocomplete
              • class \Drupal\social_group\Element\SocialGroupEntityAutocomplete

1 file declares its use of SocialGroupEntityAutocomplete

social_group.module in modules/social_features/social_group/social_group.module

The Social group module.

File

modules/social_features/social_group/src/Element/SocialGroupEntityAutocomplete.php, line 19

Namespace

Drupal\social_group\Element

class SocialGroupEntityAutocomplete extends EntityAutocomplete {

  /**
   * Form element validation handler for entity_autocomplete elements.
   */
  public static function validateEntityAutocomplete(array &$element, FormStateInterface $form_state, array &$complete_form, $select2 = FALSE) {
    $duplicated_values = $value = [];

    // Load the current Group so we can see if there are existing members.
    $group = _social_group_get_current_group();

    // If we use the select 2 widget then we already got a nice array.
    if ($select2 === TRUE) {
      $input_values = $element['#value'];
    }
    else {

      // Grab all the input values so we can get the ID's out of them.
      $input_values = Tags::explode($element['#value']);
    }
    foreach ($input_values as $input) {
      $match = static::extractEntityIdFromAutocompleteInput($input);

      // If we use the select 2 widget then we already got a nice array.
      if ($select2 === TRUE) {
        $match = $input;
      }
      if ($match === NULL) {
        $options = $element['#selection_settings'] + [
          'target_type' => $element['#target_type'],
          'handler' => $element['#selection_handler'],
        ];

        /* @var /Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface $handler */
        $handler = \Drupal::service('plugin.manager.entity_reference_selection')
          ->getInstance($options);
        $autocreate = (bool) $element['#autocreate'] && $handler instanceof SelectionWithAutocreateInterface;

        // Try to get a match from the input string when the user didn't use
        // the autocomplete but filled in a value manually.
        // Got this from the parent::validateEntityAutocomplete.
        $match = static::matchEntityByTitle($handler, $input, $element, $form_state, !$autocreate);
      }
      if ($match !== NULL) {
        $value[$match] = [
          'target_id' => $match,
        ];
        $account = User::load($match);

        // User is already a member, add it to an array for the Form element
        // to render an error after all checks are gone.
        if ($group
          ->getMember($account)) {
          $duplicated_values[] = $account
            ->getDisplayName();
        }

        // Validate input for every single user. This way we make sure that
        // The element validates one, or more users added in the autocomplete.
        // This is because Group doesn't allow adding multiple users at once,
        // so we need to validate single users, if they all pass we can add
        // them all in the _social_group_action_form_submit.
        parent::validateEntityAutocomplete($element, $form_state, $complete_form);
      }
    }

    // If we have duplicates, provide an error message.
    if (!empty($duplicated_values)) {
      $usernames = implode(', ', $duplicated_values);
      $message = \Drupal::translation()
        ->formatPlural(count($duplicated_values), "@usernames is already member of the group, you can't add them again", "@usernames are already members of the group, you can't add them again", [
        '@usernames' => $usernames,
      ]);

      // We have to kick in a form set error here, or else the
      // GroupContentCardinalityValidator will kick in and show a faulty
      // error message. Alter this later when Group supports multiple members.
      $form_state
        ->setError($element, $message);
      return;
    }
    if ($value) {

      // Select2 gives us an array back, which errors the field even though we
      // don't use it to perform the action, but we should mimic the behaviour
      // as it would be without Select2.
      if ($select2 === TRUE) {
        $form_state
          ->setValue([
          'entity_id',
          '0',
          'target_id',
        ], $match);
      }
      $form_state
        ->setValue('entity_id_new', $value);
    }
  }

}

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
EntityAutocomplete::extractEntityIdFromAutocompleteInput	public static	function	Extracts the entity ID from the autocompletion result.
EntityAutocomplete::getEntityLabels	public static	function	Converts an array of entity objects into a string of entity labels. Overrides EntityAutocomplete::getEntityLabels
EntityAutocomplete::getInfo	public	function	Returns the element properties for this element. Overrides Textfield::getInfo
EntityAutocomplete::matchEntityByTitle	protected static	function	Finds an entity from an autocomplete input without an explicit ID.
EntityAutocomplete::processEntityAutocomplete	public static	function	Adds entity autocomplete functionality to a form element.
EntityAutocomplete::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides EntityAutocomplete::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
SocialGroupEntityAutocomplete::validateEntityAutocomplete	public static	function	Form element validation handler for entity_autocomplete elements. Overrides EntityAutocomplete::validateEntityAutocomplete
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.
Textfield::preRenderTextfield	public static	function	Prepares a #type 'textfield' render element for input.html.twig.