comment.tokens.inc 9.46 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
 */
function comment_token_info() {
  $type = array(
    'name' => t('Comments'),
    'description' => t('Tokens for comments posted on the site.'),
    'needs-data' => 'comment',
  );

18 19
  // @todo Make this work per field. See http://drupal.org/node/2031903
  $entity['comment-count'] = array(
20
    'name' => t("Comment count"),
21
    'description' => t("The number of comments posted on an entity."),
22
  );
23
  $entity['comment-count-new'] = array(
24
    'name' => t("New comment count"),
25
    'description' => t("The number of comments posted on an entity since the reader last viewed it."),
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
  );

  // 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
  $comment['parent'] = array(
    'name' => t("Parent"),
    'description' => t("The comment's parent, if comment threading is active."),
    'type' => 'comment',
  );
82 83 84 85 86 87 88
  $comment['entity'] = array(
    'name' => t("Entity"),
    'description' => t("The entity the comment was posted to."),
    'type' => 'entity',
  );
  // Support legacy comment node tokens, since tokes are embedded in user data
  // and can't be upgraded directly.
89 90
  $comment['node'] = array(
    'name' => t("Node"),
91
    'description' => t("DEPRECATED: The node the comment was posted to."),
92 93 94 95 96 97 98 99 100 101 102
    '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(
103
      'entity' => $entity,
104
      'comment' => $comment,
105 106
      // Support deprecated node tokens.
      'node' => $entity,
107 108 109 110 111
    ),
  );
}

/**
112
 * Implements hook_tokens().
113 114
 */
function comment_tokens($type, $tokens, array $data = array(), array $options = array()) {
115
  $token_service = \Drupal::token();
116

117
  $url_options = array('absolute' => TRUE);
118 119 120
  if (isset($options['langcode'])) {
    $url_options['language'] = language_load($options['langcode']);
    $langcode = $options['langcode'];
121 122
  }
  else {
123
    $langcode = NULL;
124 125 126 127 128 129
  }
  $sanitize = !empty($options['sanitize']);

  $replacements = array();

  if ($type == 'comment' && !empty($data['comment'])) {
130
    /** @var \Drupal\comment\CommentInterface $comment */
131 132 133 134 135 136
    $comment = $data['comment'];

    foreach ($tokens as $name => $original) {
      switch ($name) {
        // Simple key values on the comment.
        case 'cid':
137
          $replacements[$original] = $comment->id();
138 139
          break;

140
        // Poster identity information for comments.
141
        case 'hostname':
142
          $replacements[$original] = $sanitize ? check_plain($comment->getHostname()) : $comment->getHostname();
143 144 145
          break;

        case 'name':
146
          $name = ($comment->getOwnerId() == 0) ? \Drupal::config('user.settings')->get('anonymous') : $comment->getAuthorName();
147 148 149 150
          $replacements[$original] = $sanitize ? filter_xss($name) : $name;
          break;

        case 'mail':
151
          $mail = $comment->getAuthorEmail();
152 153 154 155
          $replacements[$original] = $sanitize ? check_plain($mail) : $mail;
          break;

        case 'homepage':
156
          $replacements[$original] = $sanitize ? check_url($comment->getHomepage()) : $comment->getHomepage();
157 158 159
          break;

        case 'title':
160
          $replacements[$original] = $sanitize ? filter_xss($comment->getSubject()) : $comment->getSubject();
161 162 163
          break;

        case 'body':
164
          $replacements[$original] = $sanitize ? $comment->comment_body->processed : $comment->comment_body->value;
165 166 167 168
          break;

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

        case 'edit-url':
174
          $url_options['fragment'] = NULL;
175
          $replacements[$original] = url('comment/' . $comment->id() . '/edit', $url_options);
176 177
          break;

178 179 180
        // @todo Remove 'name' token in favour of 'author'. See
        //   https://drupal.org/node/920056.
        case 'name':
181
        case 'author':
182 183
          $name = $comment->getAuthorName();
          $replacements[$original] = $sanitize ? filter_xss($name) : $name;
184 185 186
          break;

        case 'parent':
187 188 189
          if ($comment->hasParentComment()) {
            $parent = $comment->getParentComment();
            $replacements[$original] = $sanitize ? filter_xss($parent->getSubject()) : $parent->getSubject();
190 191 192 193
          }
          break;

        case 'created':
194
          $replacements[$original] = format_date($comment->getCreatedTime(), 'medium', '', NULL, $langcode);
195 196 197
          break;

        case 'changed':
198
          $replacements[$original] = format_date($comment->getChangedTime(), 'medium', '', NULL, $langcode);
199 200
          break;

201
        case 'entity':
202
          $entity = $comment->getCommentedEntity();
203
          $title = $entity->label();
204
          $replacements[$original] = $sanitize ? filter_xss($title) : $title;
205
          break;
206 207 208 209 210

        case 'node':
          // Support legacy comment node tokens, since tokes are embedded in
          // user data and can't be upgraded directly.
          // @todo Remove in Drupal 9, see https://drupal.org/node/2031901.
211 212
          if ($comment->getCommentedEntityTypeId() == 'node') {
            $entity = $comment->getCommentedEntity();
213 214 215 216 217 218 219
            $title = $entity->label();
            $replacements[$original] = $sanitize ? filter_xss($title) : $title;
          }
          else {
            $replacements[$original] = NULL;
          }
          break;
220 221 222 223
      }
    }

    // Chained token relationships.
224
    if ($entity_tokens = $token_service->findwithPrefix($tokens, 'entity')) {
225 226
      $entity = $comment->getCommentedEntity();
      $replacements += $token_service->generate($comment->getCommentedEntityTypeId(), $entity_tokens, array($comment->getCommentedEntityTypeId() => $entity), $options);
227 228
    }

229 230
    if (($node_tokens = $token_service->findwithPrefix($tokens, 'node')) && $comment->getCommentedEntityTypeId() == 'node') {
      $node = $comment->getCommentedEntity();
231
      $replacements += $token_service->generate('node', $node_tokens, array('node' => $node), $options);
232 233
    }

234
    if ($date_tokens = $token_service->findwithPrefix($tokens, 'created')) {
235
      $replacements += $token_service->generate('date', $date_tokens, array('date' => $comment->getCreatedTime()), $options);
236 237
    }

238
    if ($date_tokens = $token_service->findwithPrefix($tokens, 'changed')) {
239
      $replacements += $token_service->generate('date', $date_tokens, array('date' => $comment->getChangedTime()), $options);
240 241
    }

242
    if (($parent_tokens = $token_service->findwithPrefix($tokens, 'parent')) && $parent = $comment->getParentComment()) {
243
      $replacements += $token_service->generate('comment', $parent_tokens, array('comment' => $parent), $options);
244 245
    }

246
    if (($author_tokens = $token_service->findwithPrefix($tokens, 'author')) && $account = $comment->getOwner()) {
247
      $replacements += $token_service->generate('user', $author_tokens, array('user' => $account), $options);
248 249
    }
  }
250 251
  elseif (($type == 'entity' & !empty($data['entity'])) ||
    ($type == 'node' & !empty($data['node']))) {
252
    /** @var $entity \Drupal\Core\Entity\ContentEntityInterface */
253
    $entity = !empty($data['entity']) ? $data['entity'] : $data['node'];
254 255

    foreach ($tokens as $name => $original) {
256
      switch ($name) {
257
        case 'comment-count':
258
          $count = 0;
259
          $fields = array_keys(\Drupal::service('comment.manager')->getFields($entity->getEntityTypeId()));
260 261 262 263 264 265
          $definitions = array_keys($entity->getPropertyDefinitions());
          $valid_fields = array_intersect($fields, $definitions);
          foreach ($valid_fields as $field_name) {
            $count += $entity->get($field_name)->comment_count;
          }
          $replacements[$original] = $count;
266 267 268
          break;

        case 'comment-count-new':
269
          $replacements[$original] = comment_num_new($entity->id(), $entity->getEntityTypeId());
270 271 272 273 274 275 276
          break;
      }
    }
  }

  return $replacements;
}