comment.tokens.inc 7.49 KB
Newer Older
1 2 3 4 5 6 7 8
<?php

/**
 * @file
 * Builds placeholder replacement tokens for comment-related data.
 */

/**
9
 * Implements hook_token_info().
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
 */
function comment_token_info() {
  $type = array(
    'name' => t('Comments'),
    'description' => t('Tokens for comments posted on the site.'),
    'needs-data' => 'comment',
  );

  // Comment-related tokens for nodes
  $node['comment-count'] = array(
    'name' => t("Comment count"),
    'description' => t("The number of comments posted on a node."),
  );
  $node['comment-count-new'] = array(
    'name' => t("New comment count"),
    'description' => t("The number of comments posted on a node since the reader last viewed it."),
  );

  // Core comment tokens
  $comment['cid'] = array(
    'name' => t("Comment ID"),
    'description' => t("The unique ID of the comment."),
  );
  $comment['hostname'] = array(
    'name' => t("IP Address"),
    'description' => t("The IP address of the computer the comment was posted from."),
  );
  $comment['name'] = array(
    'name' => t("Name"),
    'description' => t("The name left by the comment author."),
  );
  $comment['mail'] = array(
    'name' => t("Email address"),
    'description' => t("The email address left by the comment author."),
  );
  $comment['homepage'] = array(
    'name' => t("Home page"),
    'description' => t("The home page URL left by the comment author."),
  );
  $comment['title'] = array(
    'name' => t("Title"),
    'description' => t("The title of the comment."),
  );
  $comment['body'] = array(
    'name' => t("Content"),
    'description' => t("The formatted content of the comment itself."),
  );
  $comment['url'] = array(
    'name' => t("URL"),
    'description' => t("The URL of the comment."),
  );
  $comment['edit-url'] = array(
    'name' => t("Edit URL"),
    'description' => t("The URL of the comment's edit page."),
  );

  // Chained tokens for comments
  $comment['created'] = array(
    'name' => t("Date created"),
    'description' => t("The date the comment was posted."),
    'type' => 'date',
  );
72 73 74 75 76
  $comment['changed'] = array(
    'name' => t("Date changed"),
    'description' => t("The date the comment was most recently updated."),
    'type' => 'date',
  );
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
  $comment['parent'] = array(
    'name' => t("Parent"),
    'description' => t("The comment's parent, if comment threading is active."),
    'type' => 'comment',
  );
  $comment['node'] = array(
    'name' => t("Node"),
    'description' => t("The node the comment was posted to."),
    'type' => 'node',
  );
  $comment['author'] = array(
    'name' => t("Author"),
    'description' => t("The author of the comment, if they were logged in."),
    'type' => 'user',
  );

  return array(
    'types' => array('comment' => $type),
    'tokens' => array(
      'node' => $node,
      'comment' => $comment,
    ),
  );
}

/**
103
 * Implements hook_tokens().
104 105 106
 */
function comment_tokens($type, $tokens, array $data = array(), array $options = array()) {
  $url_options = array('absolute' => TRUE);
107 108 109
  if (isset($options['langcode'])) {
    $url_options['language'] = language_load($options['langcode']);
    $langcode = $options['langcode'];
110 111
  }
  else {
112
    $langcode = NULL;
113 114 115 116 117 118 119 120 121 122 123 124
  }
  $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':
125
          $replacements[$original] = $comment->id();
126 127 128 129
          break;

        // Poster identity information for comments
        case 'hostname':
130
          $replacements[$original] = $sanitize ? check_plain($comment->hostname->value) : $comment->hostname->value;
131 132 133
          break;

        case 'name':
134
          $name = ($comment->uid->target_id == 0) ? config('user.settings')->get('anonymous') : $comment->name->value;
135 136 137 138
          $replacements[$original] = $sanitize ? filter_xss($name) : $name;
          break;

        case 'mail':
139 140
          if ($comment->uid->target_id != 0) {
            $account = user_load($comment->uid->target_id);
141 142 143
            $mail = $account->mail;
          }
          else {
144
            $mail = $comment->mail->value;
145 146 147 148 149
          }
          $replacements[$original] = $sanitize ? check_plain($mail) : $mail;
          break;

        case 'homepage':
150
          $replacements[$original] = $sanitize ? check_url($comment->homepage->value) : $comment->homepage->value;
151 152 153
          break;

        case 'title':
154
          $replacements[$original] = $sanitize ? filter_xss($comment->subject->value) : $comment->subject->value;
155 156 157
          break;

        case 'body':
158
          $replacements[$original] = $sanitize ? $comment->comment_body->processed : $comment->comment_body->value;
159 160 161 162
          break;

        // Comment related URLs.
        case 'url':
163 164
          $url_options['fragment']  = 'comment-' . $comment->id();
          $replacements[$original] = url('comment/' . $comment->id(), $url_options);
165 166 167
          break;

        case 'edit-url':
168
          $url_options['fragment'] = NULL;
169
          $replacements[$original] = url('comment/' . $comment->id() . '/edit', $url_options);
170 171 172 173
          break;

        // Default values for the chained tokens handled below.
        case 'author':
174
          $replacements[$original] = $sanitize ? filter_xss($comment->name->value) : $comment->name->value;
175 176 177
          break;

        case 'parent':
178 179
          if (!empty($comment->pid->target_id)) {
            $parent = comment_load($comment->pid->target_id);
180 181 182 183 184
            $replacements[$original] = $sanitize ? filter_xss($parent->subject) : $parent->subject;
          }
          break;

        case 'created':
185
          $replacements[$original] = format_date($comment->created->value, 'medium', '', NULL, $langcode);
186 187 188
          break;

        case 'changed':
189
          $replacements[$original] = format_date($comment->changed->value, 'medium', '', NULL, $langcode);
190 191 192
          break;

        case 'node':
193
          $node = $comment->nid->entity;
194
          $title = $node->label();
195
          $replacements[$original] = $sanitize ? filter_xss($title) : $title;
196 197 198 199 200 201
          break;
      }
    }

    // Chained token relationships.
    if ($node_tokens = token_find_with_prefix($tokens, 'node')) {
202
      $node = $comment->nid->entity;
203 204 205 206
      $replacements += token_generate('node', $node_tokens, array('node' => $node), $options);
    }

    if ($date_tokens = token_find_with_prefix($tokens, 'created')) {
207
      $replacements += token_generate('date', $date_tokens, array('date' => $comment->created->value), $options);
208 209
    }

210
    if ($date_tokens = token_find_with_prefix($tokens, 'changed')) {
211
      $replacements += token_generate('date', $date_tokens, array('date' => $comment->changed->value), $options);
212 213
    }

214
    if (($parent_tokens = token_find_with_prefix($tokens, 'parent')) && $parent = $comment->pid->entity) {
215 216 217
      $replacements += token_generate('comment', $parent_tokens, array('comment' => $parent), $options);
    }

218
    if (($author_tokens = token_find_with_prefix($tokens, 'author')) && $account = $comment->uid->entity) {
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
      $replacements += token_generate('user', $author_tokens, array('user' => $account), $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;
}