class SocialEnrollmentAutocomplete in Open Social 10.2.x
Same name and namespace in other branches
- 8.9 modules/social_features/social_event/modules/social_event_managers/src/Element/SocialEnrollmentAutocomplete.php \Drupal\social_event_managers\Element\SocialEnrollmentAutocomplete
- 8.5 modules/social_features/social_event/modules/social_event_managers/src/Element/SocialEnrollmentAutocomplete.php \Drupal\social_event_managers\Element\SocialEnrollmentAutocomplete
- 8.6 modules/social_features/social_event/modules/social_event_managers/src/Element/SocialEnrollmentAutocomplete.php \Drupal\social_event_managers\Element\SocialEnrollmentAutocomplete
- 8.7 modules/social_features/social_event/modules/social_event_managers/src/Element/SocialEnrollmentAutocomplete.php \Drupal\social_event_managers\Element\SocialEnrollmentAutocomplete
- 8.8 modules/social_features/social_event/modules/social_event_managers/src/Element/SocialEnrollmentAutocomplete.php \Drupal\social_event_managers\Element\SocialEnrollmentAutocomplete
- 10.3.x modules/social_features/social_event/modules/social_event_managers/src/Element/SocialEnrollmentAutocomplete.php \Drupal\social_event_managers\Element\SocialEnrollmentAutocomplete
- 10.0.x modules/social_features/social_event/modules/social_event_managers/src/Element/SocialEnrollmentAutocomplete.php \Drupal\social_event_managers\Element\SocialEnrollmentAutocomplete
- 10.1.x modules/social_features/social_event/modules/social_event_managers/src/Element/SocialEnrollmentAutocomplete.php \Drupal\social_event_managers\Element\SocialEnrollmentAutocomplete
Provides an Enroll 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_enrollment_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_event_managers\Element\SocialEnrollmentAutocomplete
- class \Drupal\social_core\Entity\Element\EntityAutocomplete
- class \Drupal\Core\Entity\Element\EntityAutocomplete
- class \Drupal\Core\Render\Element\Textfield
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of SocialEnrollmentAutocomplete
1 file declares its use of SocialEnrollmentAutocomplete
- SocialEventManagersAddEnrolleeForm.php in modules/
social_features/ social_event/ modules/ social_event_managers/ src/ Form/ SocialEventManagersAddEnrolleeForm.php
1 #type use of SocialEnrollmentAutocomplete
- EnrollInviteUserForm::buildForm in modules/
social_features/ social_event/ modules/ social_event_invite/ src/ Form/ EnrollInviteUserForm.php - Form constructor.
File
- modules/
social_features/ social_event/ modules/ social_event_managers/ src/ Element/ SocialEnrollmentAutocomplete.php, line 20
Namespace
Drupal\social_event_managers\ElementView source
class SocialEnrollmentAutocomplete 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 Event enrollments so we can check duplicates.
$storage = \Drupal::entityTypeManager()
->getStorage('event_enrollment');
$node = \Drupal::routeMatch()
->getParameter('node');
if ($node instanceof NodeInterface) {
// You can get nid and anything else you need from the node object.
$nid = $node
->id();
}
elseif (!is_object($node)) {
$nid = $node;
}
$input_values = $element['#value'];
if ($select2 !== TRUE) {
// 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,
];
$enrollments = $storage
->loadByProperties([
'field_event' => $nid,
'field_account' => $match,
]);
// If the social_event_invite module is enabled, we want to check if
// an user is already invited, but not really enrolled yet.
if (\Drupal::moduleHandler()
->moduleExists('social_event_invite')) {
$invited_or_joined = TRUE;
// So if this user is already invited or joined we keep them.
$status_checks = [
EventEnrollmentInterface::REQUEST_OR_INVITE_DECLINED,
EventEnrollmentInterface::INVITE_INVALID_OR_EXPIRED,
];
/** @var \Drupal\social_event\Entity\EventEnrollment $enrollment */
foreach ($enrollments as $id => $enrollment) {
if (in_array((int) $enrollment->field_request_or_invite_status->value, $status_checks)) {
$invited_or_joined = FALSE;
unset($enrollments[$id]);
}
}
}
// User is already a member, add it to an array for the Form element
// to render an error after all checks are gone.
if (!empty($enrollments)) {
$duplicated_values[] = $input;
}
// We need set "validate_reference" for element to prevent
// receive notice Undefined index #validate_reference.
if (!isset($element['#validate_reference'])) {
$element['#validate_reference'] = FALSE;
}
// 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 we don'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 enrolled, you can't add them again", "@usernames are already enrolled, you can't add them again", [
'@usernames' => $usernames,
]);
if (\Drupal::moduleHandler()
->moduleExists('social_event_invite') && $invited_or_joined === TRUE) {
$message = \Drupal::translation()
->formatPlural(count($duplicated_values), "@usernames is already invited or enrolled, you can't invite them again", "@usernames are already invited or enrolled, you can't invite 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) {
$form_state
->setValue('entity_id_new', $value);
$form_state
->setValue('node_id', $nid);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityAutocomplete:: |
public static | function | Extracts the entity ID from the autocompletion result. | |
EntityAutocomplete:: |
public static | function |
Converts an array of entity objects into a string of entity labels. Overrides EntityAutocomplete:: |
|
EntityAutocomplete:: |
public | function |
Returns the element properties for this element. Overrides Textfield:: |
|
EntityAutocomplete:: |
protected static | function | Finds an entity from an autocomplete input without an explicit ID. | |
EntityAutocomplete:: |
public static | function | Adds entity autocomplete functionality to a form element. | |
EntityAutocomplete:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides EntityAutocomplete:: |
|
FormElement:: |
public static | function | Adds autocomplete functionality to elements. | |
FormElement:: |
public static | function | #process callback for #pattern form element property. | |
FormElement:: |
public static | function | #element_validate callback for #pattern form element property. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 98 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
SocialEnrollmentAutocomplete:: |
public static | function |
Form element validation handler for entity_autocomplete elements. Overrides EntityAutocomplete:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
Textfield:: |
public static | function | Prepares a #type 'textfield' render element for input.html.twig. |