function comment_tokens

Implements hook_tokens().

File

drupal/core/modules/comment/comment.tokens.inc, line 105

Builds placeholder replacement tokens for comment-related data.

Code

function comment_tokens($type, $tokens, array $data = array(), array $options = array()) {
  $token_service = Drupal::token();
  $url_options = array(
    'absolute' => TRUE,
  );
  if (isset($options['langcode'])) {
    $url_options['language'] = language_load($options['langcode']);
    $langcode = $options['langcode'];
  }
  else {
    $langcode = NULL;
  }
  $sanitize = !empty($options['sanitize']);
  $replacements = array();
  if ($type == 'comment' && !empty($data['comment'])) {
    $comment = $data['comment'];
    foreach ($tokens as $name => $original) {
      switch ($name) {

        // Simple key values on the comment.
        case 'cid':
          $replacements[$original] = $comment
            ->id();
          break;

        // Poster identity information for comments
        case 'hostname':
          $replacements[$original] = $sanitize ? check_plain($comment->hostname->value) : $comment->hostname->value;
          break;
        case 'name':
          $name = $comment->uid->target_id == 0 ? config('user.settings')
            ->get('anonymous') : $comment->name->value;
          $replacements[$original] = $sanitize ? filter_xss($name) : $name;
          break;
        case 'mail':
          if ($comment->uid->target_id != 0) {
            $account = user_load($comment->uid->target_id);
            $mail = $account->mail;
          }
          else {
            $mail = $comment->mail->value;
          }
          $replacements[$original] = $sanitize ? check_plain($mail) : $mail;
          break;
        case 'homepage':
          $replacements[$original] = $sanitize ? check_url($comment->homepage->value) : $comment->homepage->value;
          break;
        case 'title':
          $replacements[$original] = $sanitize ? filter_xss($comment->subject->value) : $comment->subject->value;
          break;
        case 'body':
          $replacements[$original] = $sanitize ? $comment->comment_body->processed : $comment->comment_body->value;
          break;

        // Comment related URLs.
        case 'url':
          $url_options['fragment'] = 'comment-' . $comment
            ->id();
          $replacements[$original] = url('comment/' . $comment
            ->id(), $url_options);
          break;
        case 'edit-url':
          $url_options['fragment'] = NULL;
          $replacements[$original] = url('comment/' . $comment
            ->id() . '/edit', $url_options);
          break;

        // Default values for the chained tokens handled below.
        case 'author':
          $replacements[$original] = $sanitize ? filter_xss($comment->name->value) : $comment->name->value;
          break;
        case 'parent':
          if (!empty($comment->pid->target_id)) {
            $parent = comment_load($comment->pid->target_id);
            $replacements[$original] = $sanitize ? filter_xss($parent->subject) : $parent->subject;
          }
          break;
        case 'created':
          $replacements[$original] = format_date($comment->created->value, 'medium', '', NULL, $langcode);
          break;
        case 'changed':
          $replacements[$original] = format_date($comment->changed->value, 'medium', '', NULL, $langcode);
          break;
        case 'node':
          $node = $comment->nid->entity;
          $title = $node
            ->label();
          $replacements[$original] = $sanitize ? filter_xss($title) : $title;
          break;
      }
    }

    // Chained token relationships.
    if ($node_tokens = $token_service
      ->findwithPrefix($tokens, 'node')) {
      $node = $comment->nid->entity;
      $replacements += $token_service
        ->generate('node', $node_tokens, array(
        'node' => $node,
      ), $options);
    }
    if ($date_tokens = $token_service
      ->findwithPrefix($tokens, 'created')) {
      $replacements += $token_service
        ->generate('date', $date_tokens, array(
        'date' => $comment->created->value,
      ), $options);
    }
    if ($date_tokens = $token_service
      ->findwithPrefix($tokens, 'changed')) {
      $replacements += $token_service
        ->generate('date', $date_tokens, array(
        'date' => $comment->changed->value,
      ), $options);
    }
    if (($parent_tokens = $token_service
      ->findwithPrefix($tokens, 'parent')) && ($parent = $comment->pid->entity)) {
      $replacements += $token_service
        ->generate('comment', $parent_tokens, array(
        'comment' => $parent,
      ), $options);
    }
    if (($author_tokens = $token_service
      ->findwithPrefix($tokens, 'author')) && ($account = $comment->uid->entity)) {
      $replacements += $token_service
        ->generate('user', $author_tokens, array(
        'user' => $account
          ->getBCEntity(),
      ), $options);
    }
  }
  elseif ($type == 'node' & !empty($data['node'])) {
    $node = $data['node'];
    foreach ($tokens as $name => $original) {
      switch ($name) {
        case 'comment-count':
          $replacements[$original] = $node->comment_count;
          break;
        case 'comment-count-new':
          $replacements[$original] = comment_num_new($node->nid);
          break;
      }
    }
  }
  return $replacements;
}