search_api_saved_searches.tokens.inc in Search API Saved Searches 7

Builds placeholder replacement tokens for user-related data.

File

search_api_saved_searches.tokens.inc

<?php

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

/**
 * Implements hook_token_info().
 *
 * Provides the following tokens:
 * - [user:search-api-saved-searches-url]
 * - [search-api-saved-searches:quantity]
 * - [search-api-saved-searches:results]
 * - [search-api-saved-search:name]
 * - [search-api-saved-search:created]
 * - [search-api-saved-search:quantity]
 * - [search-api-saved-search:items]
 * - [search-api-saved-search:results-capped]
 * - [search-api-saved-search:view-url]
 * - [search-api-saved-search:activate-url]
 * - [search-api-saved-search:edit-url]
 * - [search-api-saved-search:delete-url]
 * - [search-api-saved-search-result:label]
 * - [search-api-saved-search-result:url]
 *
 * The used data types are the following:
 * - search_api_saved_searches: An array with values of type
 *   search_api_saved_search_info.
 * - search_api_saved_search_info: An associative array containing:
 *   - search: A SearchApiSavedSearch entity object.
 *   - result_count: An integer telling how many new results there are for this
 *     saved search.
 *   - results: An array of items of the type that the index associated with
 *     this saved search contains.
 * - search_api_saved_search_result_info: An associative array containing:
 *   - search: A SearchApiSavedSearch entity object.
 *   - entity: An item of the type corresponding to the saved search.
 *
 * @see search_api_saved_searches_tokens()
 */
function search_api_saved_searches_token_info() {
  $info['types']['search-api-saved-searches'] = array(
    'name' => t('Search API saved searches'),
    'description' => t('Tokens related to several saved searches at once.'),
    'needs-data' => 'search_api_saved_searches',
  );
  $info['types']['search-api-saved-search'] = array(
    'name' => t('Search API saved search'),
    'description' => t('Tokens related to a saved search.'),
    'needs-data' => 'search_api_saved_search_info',
  );
  $info['types']['search-api-saved-search-result'] = array(
    'name' => t('Search API saved search result'),
    'description' => t('Tokens related to a result of a saved search.'),
    'needs-data' => 'search_api_saved_search_result_info',
  );
  $tokens =& $info['tokens'];
  $tokens['user']['search-api-saved-searches-url'] = array(
    'name' => t('Config URL'),
    'description' => t('The URL under which a user can configure her saved searches.'),
    'type' => 'url',
  );
  $tokens['search-api-saved-searches']['quantity'] = array(
    'name' => t('Number of results'),
    'description' => t('Number of results for all saved searches in this message.'),
  );
  $tokens['search-api-saved-searches']['results'] = array(
    'name' => t('Results'),
    'description' => t('Text listing new results for one or more saved searches.'),
  );
  $search =& $tokens['search-api-saved-search'];
  $search['name'] = array(
    'name' => t('Name'),
    'description' => t('The name of the saved search.'),
  );
  $search['created'] = array(
    'name' => t('Date created'),
    'description' => t('The date on which the saved search was created.'),
    'type' => 'date',
  );
  $search['quantity'] = array(
    'name' => t('Number of results'),
    'description' => t('Number of results for the saved search.'),
  );
  $search['items'] = array(
    'name' => t('Results'),
    'description' => t('Text listing new results for the saved search.'),
  );
  $search['results-capped'] = array(
    'name' => t('"Displayed results truncated" text'),
    'description' => t('Text explaining that not all new results were displayed, if applicable.'),
  );
  $search['view-url'] = array(
    'name' => t('View URL'),
    'description' => t('The URL of the page displaying this search, if any.'),
    'type' => 'url',
  );
  $search['activate-url'] = array(
    'name' => t('Activate URL'),
    'description' => t('The URL for activating the saved search, if necessary.'),
    'type' => 'url',
  );
  $search['edit-url'] = array(
    'name' => t('Edit URL'),
    'description' => t("The URL for editing the saved search's notification interval."),
    'type' => 'url',
  );
  $search['delete-url'] = array(
    'name' => t('Delete URL'),
    'description' => t('The URL for deleting the saved search.'),
    'type' => 'url',
  );
  $tokens['search-api-saved-search-result']['id'] = array(
    'name' => t('ID'),
    'description' => t('The item id for the result.'),
  );
  $tokens['search-api-saved-search-result']['label'] = array(
    'name' => t('Label'),
    'description' => t('The human-readable label for the result.'),
  );
  $tokens['search-api-saved-search-result']['url'] = array(
    'name' => t('URL'),
    'description' => t('The URL at which the result can be viewed.'),
    'type' => 'url',
  );
  return $info;
}

/**
 * Implements hook_tokens().
 *
 * @see search_api_saved_searches_token_info()
 */
function search_api_saved_searches_tokens($type, array $tokens, array $data = array(), array $options = array()) {
  $url_options = array(
    'absolute' => TRUE,
  );
  if (isset($options['language'])) {
    $url_options['language'] = $options['language'];
    $language_code = $options['language']->language;
  }
  else {
    $language_code = NULL;
  }
  $sanitize = !empty($options['sanitize']);
  $replacements = array();
  switch ($type) {
    case 'user':
      if (isset($tokens['search-api-saved-searches-url'])) {
        $url_tokens = token_find_with_prefix($tokens, 'search-api-saved-searches-url');
        if (!empty($data['user']->uid)) {
          $path = 'user/' . $data['user']->uid . '/saved-searches';
          $replacements[$tokens['search-api-saved-searches-url']] = url($path, $url_options);
          if ($url_tokens) {
            $replacements += token_generate('url', $url_tokens, array(
              'path' => $path,
            ), $options);
          }
        }
        else {
          $replacements[$tokens['search-api-saved-searches-url']] = '';
          foreach ($url_tokens as $token) {
            $replacements[$token] = '';
          }
        }
      }
      break;
    case 'search-api-saved-searches':
      if (!empty($data['search_api_saved_searches'])) {
        if (isset($tokens['results'])) {
          $results = array();
          foreach ($data['search_api_saved_searches'] as $info) {

            /** @var SearchApiSavedSearch $search */
            $search = $info['search'];
            $settings = $search
              ->settings();
            if (empty($settings->options['mail']['notify']['results'])) {
              continue;
            }
            $text = $settings
              ->getTranslatedOption('mail.notify.results', $language_code);
            $params['user'] = $search
              ->user();
            $params['search_api_saved_search_info'] = $info;
            $results[] = token_replace($text, $params, $options);
          }
          $text = implode("\n\n", $results);
          $replacements[$tokens['results']] = $sanitize ? check_plain($text) : $text;
        }
        if (isset($tokens['quantity'])) {
          $quantity = 0;
          foreach ($data['search_api_saved_searches'] as $info) {
            if (isset($info['result_count'])) {
              $quantity += $info['result_count'];
            }
          }
          $replacements[$tokens['quantity']] = $quantity;
        }
      }
      break;
    case 'search-api-saved-search':
      if (!empty($data['search_api_saved_search_info']['search'])) {
        $info = $data['search_api_saved_search_info'];

        /** @var SearchApiSavedSearch $search */
        $search = $info['search'];
        foreach ($tokens as $name => $original) {
          switch ($name) {
            case 'name':
              $replacements[$original] = $sanitize ? check_plain($search->name) : $search->name;
              break;
            case 'created':
              $replacements[$original] = format_date($search->created, 'medium', '', NULL, $language_code);
              break;
            case 'quantity':
              if (empty($info['result_count'])) {
                $replacements[$original] = 0;
                break;
              }
              $replacements[$original] = $info['result_count'];
              break;
            case 'items':
              if (!empty($info['results'])) {
                $results = array();
                $settings = $search
                  ->settings();
                $text = $settings
                  ->getTranslatedOption('mail.notify.result', $language_code);
                if (empty($text)) {
                  break;
                }
                $item_type = $search
                  ->index()->item_type;
                foreach ($info['results'] as $item) {
                  $params = array(
                    $item_type => $item,
                    'search_api_saved_search_result_info' => array(
                      'search' => $search,
                      'entity' => $item,
                    ),
                  );
                  $results[] = token_replace($text, $params, $options);
                }
                $text = implode("\n", $results);
                $replacements[$original] = $sanitize ? check_plain($text) : $text;
              }
              break;
            case 'results-capped':
              if ($info['result_count'] == count($info['results'])) {
                $replacements[$original] = '';
                break;
              }
              $settings = $search
                ->settings();
              $text = $settings
                ->getTranslatedOption('mail.notify.results_capped', $language_code);
              $text = token_replace($text, $data, $options);
              $replacements[$original] = $sanitize ? check_plain($text) : $text;
              break;
            case 'view-url':
              $replacements[$original] = $search
                ->url();
              break;
            case 'activate-url':
              $key = isset($search->options['key']) ? '/' . $search->options['key'] : '';
              $replacements[$original] = url('search-api/saved-search/' . $search->id . '/activate' . $key, $url_options);
              break;
            case 'edit-url':
              $key = isset($search->options['key']) ? '/' . $search->options['key'] : '';
              $replacements[$original] = url('search-api/saved-search/' . $search->id . '/edit' . $key, $url_options);
              break;
            case 'delete-url':
              $key = isset($search->options['key']) ? '/' . $search->options['key'] : '';
              $replacements[$original] = url('search-api/saved-search/' . $search->id . '/delete' . $key, $url_options);
              break;
          }
        }
        if ($created_tokens = token_find_with_prefix($tokens, 'created')) {
          $replacements += token_generate('date', $created_tokens, array(
            'date' => $search->created,
          ), $options);
        }
        if ($view_url_tokens = token_find_with_prefix($tokens, 'view-url')) {
          $replacements += token_generate('url', $view_url_tokens, array(
            'path' => $search
              ->url(),
          ), $options);
        }
        if ($activate_url_tokens = token_find_with_prefix($tokens, 'activate-url')) {
          $key = isset($search->options['key']) ? '/' . $search->options['key'] : '';
          $replacements += token_generate('url', $activate_url_tokens, array(
            'path' => 'search-api/saved-search/' . $search->id . '/activate' . $key,
          ), $options);
        }
        if ($edit_url_tokens = token_find_with_prefix($tokens, 'edit-url')) {
          $key = isset($search->options['key']) ? '/' . $search->options['key'] : '';
          $replacements += token_generate('url', $edit_url_tokens, array(
            'path' => 'search-api/saved-search/' . $search->id . '/edit' . $key,
          ), $options);
        }
        if ($delete_url_tokens = token_find_with_prefix($tokens, 'delete-url')) {
          $key = isset($search->options['key']) ? '/' . $search->options['key'] : '';
          $replacements += token_generate('url', $delete_url_tokens, array(
            'path' => 'search-api/saved-search/' . $search->id . '/delete' . $key,
          ), $options);
        }
      }
      break;
    case 'search-api-saved-search-result':
      $info = $data['search_api_saved_search_result_info'];
      if (!empty($info['search']) && !empty($info['entity'])) {

        /** @var SearchApiSavedSearch $search */
        $search = $info['search'];
        $index = $search
          ->index();
        $item = $info['entity'];
        foreach ($tokens as $name => $original) {
          if ($name == 'id' && ($id = $index
            ->datasource()
            ->getItemId($item))) {
            $replacements[$original] = $id;
          }
          elseif ($name == 'label' && ($label = $index
            ->datasource()
            ->getItemLabel($item))) {
            $replacements[$original] = $label;
          }
          elseif ($name == 'url' && ($url = $index
            ->datasource()
            ->getItemUrl($item))) {
            $url['options'] += $url_options;
            $replacements[$original] = url($url['path'], $url['options']);
          }
        }
        if (($url_tokens = token_find_with_prefix($tokens, 'url')) && ($url = $index
          ->datasource()
          ->getItemUrl($item))) {
          $replacements += token_generate('url', $url_tokens, $url, $options);
        }
      }
      break;
  }
  return $replacements;
}

Functions

Name	Description
search_api_saved_searches_tokens	Implements hook_tokens().
search_api_saved_searches_token_info	Implements hook_token_info().