social_event.tokens.inc in Open Social 8.8

Builds placeholder replacement tokens for Social Event module.

File

modules/social_features/social_event/social_event.tokens.inc

<?php

/**
 * @file
 * Builds placeholder replacement tokens for Social Event module.
 */
use Drupal\Core\Render\BubbleableMetadata;
use Drupal\Core\Link;
use Drupal\social_event\EventEnrollmentInterface;

/**
 * Implements hook_token_info().
 */
function social_event_token_info() {
  $type = [
    'name' => t('Social Event'),
    'description' => t('Tokens from the Social Event module.'),
  ];
  $social_event['event_iam_organizing'] = [
    'name' => t('URL of the Event I organize.'),
    'description' => t('URL of the Event I organize.'),
  ];
  $social_event['enrolled_user'] = [
    'name' => t('Username of user enrolled to the event.'),
    'description' => t('Username of user enrolled to the Event. Can be an anonymous user.'),
  ];
  $social_event['enrolled_event_url'] = [
    'name' => t('Url of the Event a user enrolled to.'),
    'description' => t('Url of the Event a user enrolled to.'),
  ];
  return [
    'types' => [
      'social_event' => $type,
    ],
    'tokens' => [
      'social_event' => $social_event,
    ],
  ];
}

/**
 * Implements hook_tokens().
 */
function social_event_tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata) {
  $replacements = [];
  if ($type === 'social_event' && !empty($data['message'])) {
    foreach ($tokens as $name => $original) {
      switch ($name) {
        case 'event_iam_organizing':
          $enrollment = $data['message']
            ->getFieldValue('field_message_related_object', 'target_id');
          if (!empty($enrollment)) {
            $link = get_link_to_event_from_enrollment($enrollment, FALSE);
            if ($link !== NULL) {
              $replacements[$original] = $link;
            }
          }
          break;
        case 'enrolled_event_url':
          $enrollment = $data['message']
            ->getFieldValue('field_message_related_object', 'target_id');
          if (!empty($enrollment)) {
            $link = get_link_to_event_from_enrollment($enrollment, TRUE);
            if ($link !== NULL) {
              $replacements[$original] = $link;
            }
          }
          break;
        case 'enrolled_user':
          $id = $data['message']
            ->getFieldValue('field_message_related_object', 'target_id');
          if (!empty($id)) {
            $enrollment_name = get_name_from_enrollment($id);
            if ($enrollment_name !== NULL) {
              $replacements[$original] = $enrollment_name;
            }
          }
          break;
      }
    }
  }
  return $replacements;
}

/**
 * Render a link to an event as full link with title or just absolute as string.
 *
 * @param int $object_id
 *   The ID of the event enrollment.
 * @param bool $as_link
 *   True if you want the full link otherwise just a canonical URL string.
 *
 * @return string|null
 *   the Url.
 */
function get_link_to_event_from_enrollment($object_id, $as_link = FALSE) {
  $entity_storage = \Drupal::entityTypeManager()
    ->getStorage('event_enrollment');

  /** @var \Drupal\social_event\Entity\EventEnrollment $entity */
  $entity = $entity_storage
    ->load($object_id);
  if ($entity !== NULL) {
    $event_id = $entity
      ->getFieldValue('field_event', 'target_id');
    $storage = \Drupal::entityTypeManager()
      ->getStorage('node');

    /** @var \Drupal\node\Entity\Node $event */
    $event = $storage
      ->load($event_id);

    // Check if the event still exists.
    if ($event !== NULL) {
      if ($as_link) {
        $url_string = $event
          ->toUrl('canonical')
          ->toString(TRUE);
        return $url_string
          ->getGeneratedUrl();
      }
      return Link::fromTextAndUrl($event
        ->getTitle(), $event
        ->toUrl('canonical'))
        ->toString();
    }
  }
  return NULL;
}

/**
 * Get the user display name from an Enrollment also for AN.
 *
 * @param int $id
 *   the Enrollment entity ID.
 *
 * @return array|\Drupal\Component\Render\MarkupInterface|mixed|null|string
 *   Markup for the Username.
 *
 * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
 */
function get_name_from_enrollment($id) {
  $entity_storage = \Drupal::entityTypeManager()
    ->getStorage('event_enrollment');

  /** @var \Drupal\social_event\Entity\EventEnrollment $entity */
  $enrollment = $entity_storage
    ->load($id);

  // User is AN by default.
  $enrollment_name = \Drupal::configFactory()
    ->get('user.settings')
    ->get('anonymous');
  if ($enrollment instanceof EventEnrollmentInterface) {

    // If there is a Uid. Lets load the user and return his display name.
    if ($enrollment !== NULL && $enrollment
      ->hasField('field_account') && $enrollment
      ->getFieldValue('field_account', 'target_id') > 0) {
      $entity_storage = \Drupal::entityTypeManager()
        ->getStorage('user');

      /** @var \Drupal\user\Entity\User $user */
      $user = $entity_storage
        ->load($enrollment
        ->getFieldValue('field_account', 'target_id'));
      return $user
        ->getDisplayName();
    }
  }

  // User is AN but has enrollment settings available, lets see if we can get
  // the Firstname and lastname to show up in the notification.
  if ($enrollment !== NULL && $enrollment
    ->hasField('field_first_name') && $enrollment
    ->getFieldValue('field_first_name', 'value') !== NULL && $enrollment
    ->getFieldValue('field_last_name', 'value') !== NULL) {

    // Create the Name from AN Attendees if possible.
    $enrollment_name = $enrollment
      ->getFieldValue('field_first_name', 'value') . ' ' . $enrollment
      ->getFieldValue('field_last_name', 'value');
  }
  return $enrollment_name;
}

Functions

Name	Description
get_link_to_event_from_enrollment	Render a link to an event as full link with title or just absolute as string.
get_name_from_enrollment	Get the user display name from an Enrollment also for AN.
social_event_tokens	Implements hook_tokens().
social_event_token_info	Implements hook_token_info().