simplenews.tokens.inc in Simplenews 7

Token related hook implementations.

File

simplenews.tokens.inc

<?php

/**
 * @file
 * Token related hook implementations.
 */

/**
 * Implements hook_token_info().
 */
function simplenews_token_info() {
  $types['simplenews-subscriber'] = array(
    'name' => t('Simplenews subscriber'),
    'description' => t('Tokens related to the newsletter recipient'),
    'needs-data' => 'simplenews_subscriber',
  );
  $types['simplenews-category'] = array(
    'name' => t('Simplenews newsletter category'),
    'description' => t('Tokens related to the newsletter category'),
    'needs-data' => 'category',
  );

  // Tokens for simplenews subscriber.
  $subscriber['subscribe-url'] = array(
    'name' => t('Subscription URL'),
    'description' => t('The URL of the page where the subscription is confirmed.'),
  );
  $subscriber['unsubscribe-url'] = array(
    'name' => t('Unsubscribe URL'),
    'description' => t('The URL of the page where the cancellation of the subscription is confirmed.'),
  );
  $subscriber['manage-url'] = array(
    'name' => t('Manage URL'),
    'description' => t('The URL of the page where the subscribers can manage their newsletter subscriptions.'),
  );
  $subscriber['combined-url'] = array(
    'name' => t('Combined confirmation URL'),
    'description' => t('The URL of the page where subscribers can confirm their subscription changes.'),
  );
  $subscriber['mail'] = array(
    'name' => t('Subscriber email'),
    'description' => t('The email address of the newsletter receiver.'),
  );
  $subscriber['user'] = array(
    'name' => t('Corresponding user'),
    'description' => t('The user object that corresponds to this subscriber. This is not set for anonymous subscribers.'),
    'type' => 'user',
  );

  // Tokens for simplenews newsletter category.
  $category['name'] = array(
    'name' => t('Newsletter category'),
    'description' => t('The name of the newsletter category.'),
  );
  $category['url'] = array(
    'name' => t('Newsletter category URL'),
    'description' => t('The URL of the page listing the issues of this newsletter category.'),
  );
  $category['term'] = array(
    'name' => t('Corresponding term'),
    'description' => t('The taxonomy term of this newsletter category'),
    'type' => 'term',
  );
  return array(
    'types' => $types,
    'tokens' => array(
      'simplenews-subscriber' => $subscriber,
      'simplenews-category' => $category,
    ),
  );
}

/**
 * Implements hook_tokens().
 *
 */
function simplenews_tokens($type, $tokens, $data = array(), $options = array()) {
  $replacements = array();
  $sanitize = !empty($options['sanitize']);
  if (isset($options['language'])) {
    $url_options['language'] = $options['language'];
    $language_code = $options['language']->language;
  }
  else {
    $language_code = NULL;
  }
  switch ($type) {
    case 'simplenews-subscriber':
      if (!isset($data['simplenews_subscriber'])) {
        return;
      }
      $subscriber = $data['simplenews_subscriber'];
      $category = isset($data['category']) ? $data['category'] : NULL;
      $language = isset($subscriber->language->language) ? $subscriber->language : user_preferred_language($subscriber);

      // Build hash for the URL of the (un)subscribe confirmation page.
      $hash = '';
      if (isset($subscriber->snid) && isset($category->tid)) {
        $hash = simplenews_generate_hash($subscriber->mail, $subscriber->snid, $category->tid);
      }
      elseif (isset($subscriber->snid)) {
        $combined_hash = simplenews_generate_hash($subscriber->mail, $subscriber->snid, 0);
      }
      foreach ($tokens as $name => $original) {
        switch ($name) {

          // Simple key values on the node.
          case 'subscribe-url':
            $replacements[$original] = url('newsletter/confirm/add/' . $hash, array(
              'absolute' => TRUE,
              'language' => $language,
            ));
            break;
          case 'unsubscribe-url':
            $replacements[$original] = url('newsletter/confirm/remove/' . $hash, array(
              'absolute' => TRUE,
              'language' => $language,
            ));
            break;
          case 'combined-url':
            $replacements[$original] = url('newsletter/confirm/combined/' . $combined_hash, array(
              'absolute' => TRUE,
              'language' => $language,
            ));
            break;
          case 'manage-url':
            $replacements[$original] = url('newsletter/subscriptions/' . $hash, array(
              'absolute' => TRUE,
              'language' => $language,
            ));
            break;
          case 'mail':
            $replacements[$original] = $sanitize ? check_plain($subscriber->mail) : $subscriber->mail;
            break;
        }
      }
      if (($user_tokens = token_find_with_prefix($tokens, 'user')) && !empty($subscriber->uid)) {
        $replacements += token_generate('user', $user_tokens, array(
          'user' => user_load($subscriber->uid),
        ), $options);
      }
      break;
    case 'simplenews-category':
      if (!isset($data['category'])) {
        return;
      }
      $category = $data['category'];
      foreach ($tokens as $name => $original) {
        switch ($name) {
          case 'name':
            if (isset($category->name)) {
              $newsletter_name = _simplenews_newsletter_name($category, $language_code);
              $replacements[$original] = $sanitize ? check_plain($newsletter_name) : $newsletter_name;
            }
            else {
              $replacements[$original] = t('Unassigned newsletter');
            }
            break;
          case 'url':
            $uri = entity_uri('taxonomy_term', $category);
            $replacements[$original] = url($uri['path'], $uri['options']);
            break;
        }
      }
      if ($term_tokens = token_find_with_prefix($tokens, 'term')) {
        $replacements += token_generate('taxonomy_term', $term_tokens, array(
          'taxonomy_term' => $category,
        ), $options);
      }
      break;
  }
  return $replacements;
}

Functions

Name	Description
simplenews_tokens	Implements hook_tokens().
simplenews_token_info	Implements hook_token_info().