ptalk-8.x-0.x-dev/ptalk.tokens.inc

<?php

/**
 * @file
 * Builds placeholder replacement tokens for ptalk module related data.
 */

use Drupal\Component\Utility\UrlHelper;
use Drupal\Core\Datetime\Entity\DateFormat;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\FieldableEntityInterface;
use Drupal\Core\Render\BubbleableMetadata;

/**
 * Implements hook_token_info().
 */
function ptalk_token_info() {
  $types['ptalk_message'] = [
    'name' => t("Ptalk messages"),
    'description' => t("Tokens related to private conversation messages."),
    'needs-data' => 'ptalk_message',
  ];
  $types['ptalk_thread'] = [
    'name' => t("Ptalk threads"),
    'description' => t("Tokens related to private conversation threads."),
    'needs-data' => 'ptalk_thread',
  ];

  // Private conversation message related variables.
  $message['mid'] = [
    'name' => t("Message ID"),
    'description' => t("The unique ID of the message."),
  ];
  $message['tid'] = [
    'name' => t("Conversation ID"),
    'description' => t("The unique ID of the related private conversation."),
  ];
  $message['author'] = [
    'name' => t("Author"),
    'description' => t("The author of the message."),
  ];
  $message['subject'] = [
    'name' => t("Subject"),
    'description' => t("The subject of the message."),
  ];
  $message['body'] = [
    'name' => t("Content"),
    'description' => t("The formatted content of the message itself."),
  ];
  $message['created'] = [
    'name' => t("Date created"),
    'description' => t("The date the message was posted."),
    'type' => 'date',
  ];
  $message['changed'] = [
    'name' => t("Date changed"),
    'description' => t("The date the message was updated."),
    'type' => 'date',
  ];
  $message['url'] = [
    'name' => t("URL"),
    'description' => t("The URL of the related private conversation to which message is belongs."),
  ];

  // Private conversation thread related variables.
  $thread['tid'] = [
    'name' => t("Thread ID"),
    'description' => t("The unique ID of the private conversation."),
  ];
  $thread['author'] = [
    'name' => t("Author"),
    'description' => t("The author of the private conversation."),
  ];
  $thread['subject'] = [
    'name' => t("Subject"),
    'description' => t("The subject of the private conversation."),
  ];
  $thread['participants'] = [
    'name' => t("Participants"),
    'description' => t("The unique participants IDS of the private conversation."),
  ];
  $thread['last-message-author'] = [
    'name' => t("Last message author"),
    'description' => t("The author which posted the last message of the private conversation."),
  ];
  $thread['created'] = [
    'name' => t("Date created"),
    'description' => t("The date the private conversation was created."),
    'type' => 'date',
  ];
  $thread['changed'] = [
    'name' => t("Date changed"),
    'description' => t("The date the private conversation was updated."),
    'type' => 'date',
  ];
  $thread['url'] = [
    'name' => t("URL"),
    'description' => t("The URL of the private conversation."),
  ];

  return [
    'types' => $types,
    'tokens' => [
      'ptalk_message' => $message,
      'ptalk_thread' => $thread,
    ],
  ];
}

/**
 * Implements hook_tokens().
 */
function ptalk_tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata) {
  $token_service = \Drupal::token();

  $url_options = ['absolute' => TRUE];
  $replacements = [];
  if ($type == 'ptalk_message' && !empty($data['ptalk_message'])) {
    $message = $data['ptalk_message'];

    foreach ($tokens as $name => $original) {
      switch ($name) {
        case 'mid':
          $replacements[$original] = $message->id();
          break;

        case 'tid':
          $replacements[$original] = $message->getThreadId();
          break;

        case 'author':
          $name = $message->getOwner()->getUserName();
          $replacements[$original] = $name;
          break;

        case 'subject':
          $subject = $message->label();
          $replacements[$original] = $subject;
          break;

        case 'body':
          $replacements[$original] = $message->body->processed;
          break;

        case 'created':
          $date_format = DateFormat::load('medium');
          $bubbleable_metadata->addCacheableDependency($date_format);
          $replacements[$original] = \Drupal::service('date.formatter')->format($message->getCreatedTime(), 'medium', '', NULL, NULL);
          break;

        case 'changed':
          $date_format = DateFormat::load('medium');
          $bubbleable_metadata->addCacheableDependency($date_format);
          $replacements[$original] = \Drupal::service('date.formatter')->format($message->getChangedTime(), 'medium', '', NULL, NULL);
          break;

        case 'url':
          $replacements[$original] = $message->getThread()->toUrl('canonical', $url_options)->toString();
          break;
      }
    }
  }

  elseif ($type == 'ptalk_thread' && !empty($data['ptalk_thread'])) {
    $thread = $data['ptalk_thread'];

    foreach ($tokens as $name => $original) {
      switch ($name) {
        case 'tid':
          $replacements[$original] = $thread->id();
          break;

        case 'author':
          $name = $thread->getOwner()->getUserName();
          $replacements[$original] = $name;
          break;

        case 'subject':
          $subject = $thread->label();
          $replacements[$original] = $subject;
          break;

        case 'participants':
          $replacements[$original] = $thread->participants->value;
          break;

        case 'last-message-author':
          $replacements[$original] = $thread->getLastMessageAuthor()->getUserName();
          break;

        case 'created':
          $date_format = DateFormat::load('medium');
          $bubbleable_metadata->addCacheableDependency($date_format);
          $replacements[$original] = \Drupal::service('date.formatter')->format($thread->getCreatedTime(), 'medium', '', NULL, NULL);
          break;

        case 'changed':
          $date_format = DateFormat::load('medium');
          $bubbleable_metadata->addCacheableDependency($date_format);
          $replacements[$original] = \Drupal::service('date.formatter')->format($thread->getChangedTime(), 'medium', '', NULL, NULL);
          break;

        case 'url':
          $replacements[$original] = $thread->toUrl('canonical', $url_options)->toString();
          break;
      }
    }
  }

  return $replacements;
}