class SocialEventInviteBulkHelper in Open Social 10.2.x

Class SocialEventBulkInvite.

@package Drupal\social_event_invite

Hierarchy

• class \Drupal\social_event_invite\SocialEventInviteBulkHelper

File

modules/social_features/social_event/modules/social_event_invite/src/SocialEventInviteBulkHelper.php, line 17

Namespace

Drupal\social_event_invite

class SocialEventInviteBulkHelper {

  /**
   * Send the invites to existing users in a batch.
   *
   * @param array $users
   *   Array containing users.
   * @param string $nid
   *   The node id.
   * @param array $context
   *   The context.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public static function bulkInviteUsers(array $users, $nid, array &$context) {
    $results = [];
    foreach ($users as $uid => $target_id) {

      // Default values.
      $fields = [
        'field_event' => $nid,
        'field_enrollment_status' => '0',
        'field_request_or_invite_status' => EventEnrollmentInterface::INVITE_PENDING_REPLY,
        'user_id' => $uid,
        'field_account' => $uid,
      ];

      // Check if this user has been invited before. It might be that the user
      // declined the invite, or that the invite is now invalid and expired.
      // We simply delete the outdated invite and create a new one.
      $conditions = [
        'field_account' => $uid,
        'field_event' => $nid,
      ];
      $eventEnrollmentStorage = \Drupal::entityTypeManager()
        ->getStorage('event_enrollment');
      $existing_enrollment = $eventEnrollmentStorage
        ->loadByProperties($conditions);
      if (!empty($existing_enrollment)) {

        /** @var \Drupal\social_event\Entity\EventEnrollment $enrollment */
        $enrollment = end($existing_enrollment);

        // Of course, only delete the previous invite if it was declined
        // or if it was invalid or expired.
        $status_checks = [
          EventEnrollmentInterface::REQUEST_OR_INVITE_DECLINED,
          EventEnrollmentInterface::INVITE_INVALID_OR_EXPIRED,
        ];
        if (in_array($enrollment->field_request_or_invite_status->value, $status_checks)) {
          $enrollment
            ->delete();
          unset($existing_enrollment[$enrollment
            ->id()]);
        }
      }

      // Clear the cache.
      $tags = [];
      $tags[] = 'enrollment:' . $nid . '-' . $uid;
      $tags[] = 'event_content_list:entity:' . $uid;
      Cache::invalidateTags($tags);

      // Create a new enrollment for the event.
      $enrollment = EventEnrollment::create($fields);

      // In order for the notifications to be sent correctly we're updating the
      // owner here. The account is still linked to the actual enrollee.
      // The owner is always used as the actor.
      // @see activity_creator_message_insert().
      $enrollment
        ->setOwnerId(\Drupal::currentUser()
        ->id());

      // Add the node id to the results so we have the nid available in the
      // finished callback so we can redirect to the correct node.
      $results[$nid] = $enrollment
        ->save();
    }
    $context['results'] = $results;
  }

  /**
   * Send the invites to emails in a batch.
   *
   * @param array $emails
   *   Array containing emails.
   * @param string $nid
   *   The node id.
   * @param array $context
   *   The context.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public static function bulkInviteEmails(array $emails, $nid, array &$context) {
    $results = [];
    foreach ($emails as $email) {
      $user = user_load_by_mail($email);

      // Default values.
      $fields = [
        'field_event' => $nid,
        'field_enrollment_status' => '0',
        'field_request_or_invite_status' => EventEnrollmentInterface::INVITE_PENDING_REPLY,
      ];
      if ($user instanceof UserInterface) {

        // Add user information.
        $fields['user_id'] = $user
          ->id();
        $fields['field_account'] = $user
          ->id();

        // Clear the cache.
        $tags = [];
        $tags[] = 'enrollment:' . $nid . '-' . $user
          ->id();
        $tags[] = 'event_content_list:entity:' . $user
          ->id();
        Cache::invalidateTags($tags);
      }
      else {

        // Add email address.
        $fields['field_email'] = $email;
      }

      // Create a new enrollment for the event.
      $enrollment = EventEnrollment::create($fields);

      // In order for the notifications to be sent correctly we're updating the
      // owner here. The account is still linked to the actual enrollee.
      // The owner is always used as the actor.
      // @see activity_creator_message_insert().
      $enrollment
        ->setOwnerId(\Drupal::currentUser()
        ->id());

      // Add the node id to the results so we have the nid available in the
      // finished callback so we can redirect to the correct node.
      $results[$nid] = $enrollment
        ->save();
    }
    $context['results'] = $results;
  }

  /**
   * Send the invites to emails in a batch.
   *
   * @param array $users
   *   Array containing user ids or user emails.
   * @param string $nid
   *   The node id.
   * @param array $context
   *   The context.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public static function bulkInviteUsersEmails(array $users, $nid, array &$context) {
    $results = [];
    foreach ($users as $user) {

      // @todo Should be merged with extractEmailsFrom from InviteEmailBaseForm.
      // Remove select2 ID parameter.
      $user = str_replace('$ID:', '', $user);
      preg_match_all("/[\\._a-zA-Z0-9+-]+@[\\._a-zA-Z0-9+-]+/i", $user, $email);
      $email = $email[0];

      // If the user is an email.
      if ($email) {
        $user = user_load_by_mail($email);

        // Default values.
        $fields = [
          'field_event' => $nid,
          'field_enrollment_status' => '0',
          'field_request_or_invite_status' => EventEnrollmentInterface::INVITE_PENDING_REPLY,
        ];
        if ($user instanceof UserInterface) {

          // Add user information.
          $fields['user_id'] = $user
            ->id();
          $fields['field_account'] = $user
            ->id();

          // Clear the cache.
          $tags = [];
          $tags[] = 'enrollment:' . $nid . '-' . $user
            ->id();
          $tags[] = 'event_content_list:entity:' . $user
            ->id();
          Cache::invalidateTags($tags);
        }
        else {

          // Add email address.
          $fields['field_email'] = $email;
        }
      }
      else {

        // Default values.
        $fields = [
          'field_event' => $nid,
          'field_enrollment_status' => '0',
          'field_request_or_invite_status' => EventEnrollmentInterface::INVITE_PENDING_REPLY,
          'user_id' => $user,
          'field_account' => $user,
        ];

        // Check if this user has been invited before. It might be that the user
        // declined the invite, or that the invite is now invalid and expired.
        // We simply delete the outdated invite and create a new one.
        $conditions = [
          'field_account' => $user,
          'field_event' => $nid,
        ];
        $eventEnrollmentStorage = \Drupal::entityTypeManager()
          ->getStorage('event_enrollment');
        $existing_enrollment = $eventEnrollmentStorage
          ->loadByProperties($conditions);
        if (!empty($existing_enrollment)) {

          /** @var \Drupal\social_event\Entity\EventEnrollment $enrollment */
          $enrollment = end($existing_enrollment);

          // Of course, only delete the previous invite if it was declined
          // or if it was invalid or expired.
          $status_checks = [
            EventEnrollmentInterface::REQUEST_OR_INVITE_DECLINED,
            EventEnrollmentInterface::INVITE_INVALID_OR_EXPIRED,
          ];
          if (in_array($enrollment->field_request_or_invite_status->value, $status_checks)) {
            $enrollment
              ->delete();
            unset($existing_enrollment[$enrollment
              ->id()]);
          }
        }

        // Clear the cache.
        $tags = [];
        $tags[] = 'enrollment:' . $nid . '-' . $user;
        $tags[] = 'event_content_list:entity:' . $user;
        Cache::invalidateTags($tags);
      }

      // Create a new enrollment for the event.
      $enrollment = EventEnrollment::create($fields);

      // In order for the notifications to be sent correctly we're updating the
      // owner here. The account is still linked to the actual enrollee.
      // The owner is always used as the actor.
      // @see activity_creator_message_insert().
      $enrollment
        ->setOwnerId(\Drupal::currentUser()
        ->id());

      // Add the node id to the results so we have the nid available in the
      // finished callback so we can redirect to the correct node.
      $results[$nid] = $enrollment
        ->save();
    }
    $context['results'] = $results;
  }

  /**
   * Callback when the batch for inviting emails for an event has finished.
   */
  public static function bulkInviteUserEmailsFinished($success, $results, $operations) {
    $nid = NULL;

    // We got the node event id in the results array so we will use that
    // to provide the param in in redirect url.
    if (!empty($results)) {

      // We don't care about resetting the array first.
      $nid = key($results);
    }
    if ($success && !empty($results)) {
      \Drupal::messenger()
        ->addStatus(t('Invite(s) have been successfully sent.'));
    }
    elseif ($success && empty($results)) {
      \Drupal::messenger()
        ->AddStatus(t('No invites were sent, recipients already received one before.'));
    }
    else {
      \Drupal::messenger()
        ->addError(t('There was an unexpected error.'));
    }

    // Redirect back to the event if we found the node ID.
    if ($nid) {
      return new RedirectResponse(Url::fromRoute('entity.node.canonical', [
        'node' => $nid,
      ])
        ->toString());
    }

    // If something went wrong, we have to redirect back to the frontpage.
    return new RedirectResponse(Url::fromRoute('<front>')
      ->toString());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SocialEventInviteBulkHelper::bulkInviteEmails	public static	function	Send the invites to emails in a batch.
SocialEventInviteBulkHelper::bulkInviteUserEmailsFinished	public static	function	Callback when the batch for inviting emails for an event has finished.
SocialEventInviteBulkHelper::bulkInviteUsers	public static	function	Send the invites to existing users in a batch.
SocialEventInviteBulkHelper::bulkInviteUsersEmails	public static	function	Send the invites to emails in a batch.