uc_addresses.tokens.inc in Ubercart Addresses 7

Hook implementations for token module.

File

uc_addresses.tokens.inc

<?php

/**
 * @file
 * Hook implementations for token module.
 */

/**
 * Implements hook_token_info().
 */
function uc_addresses_token_info() {
  $types['uc_addresses'] = array(
    'name' => t('Ubercart Addresses'),
    'description' => t('Tokens related to individual addresses'),
    'needs-data' => 'uc_addresses',
  );
  $tokens = array();

  // Ubercart Addresses tokens.
  $tokens['uc_addresses'] = array();
  $address = UcAddressesAddress::newAddress();
  $fields = uc_addresses_get_address_field_handler_instances($address, 'token');
  foreach ($fields as $fieldname => $handler) {
    $tokens['uc_addresses'] = array_merge($tokens['uc_addresses'], $handler
      ->getTokenInfo());
  }

  // Ubercart order tokens.
  $tokens['uc_order']['uc-addresses-shipping-address'] = array(
    'name' => t('Shipping address'),
    'description' => t('The order shipping address, formatted with the Ubercart Addresses module.'),
    'type' => 'uc_addresses',
  );
  $tokens['uc_order']['uc-addresses-billing-address'] = array(
    'name' => t('Billing address'),
    'description' => t('The order billing address, formatted with the Ubercart Addresses module.'),
    'type' => 'uc_addresses',
  );

  // User tokens.
  $tokens['user']['default-shipping-address'] = array(
    'name' => t('Default shipping address'),
    'description' => t('The default shipping address, formatted with the Ubercart Addresses module.'),
    'type' => 'uc_addresses',
  );
  $tokens['user']['default-billing-address'] = array(
    'name' => t('Default billing address'),
    'description' => t('The default billing address, formatted with the Ubercart Addresses module.'),
    'type' => 'uc_addresses',
  );
  return array(
    'types' => $types,
    'tokens' => $tokens,
  );
}

/**
 * Implements hook_token_info_alter().
 *
 * Removes unnecessary extra tokens generated by the entity API module.
 *
 * @return void
 */
function uc_addresses_token_info_alter(&$info) {
  foreach ($info['tokens']['uc_addresses'] as $name => $token) {
    if (!empty($token['entity-token'])) {
      unset($info['tokens']['uc_addresses'][$name]);
    }
  }
}

/**
 * Implements hook_tokens().
 */
function uc_addresses_tokens($type, $tokens, $data = array(), $options = array()) {
  $replacements = array();
  switch ($type) {
    case 'uc_addresses':
      $address = $data['uc_addresses'];
      if ($address instanceof UcAddressesAddress) {
        foreach ($tokens as $name => $original) {
          $handler = NULL;
          $fieldname = $name;
          $output_format = NULL;

          // Check if this token represents a existing address field.
          if (UcAddressesSchemaAddress::fieldExists($fieldname)) {
            $handler = uc_addresses_get_address_field_handler($address, $fieldname, 'token');
          }
          else {

            // Check if this token represents a particular output format of an existing address field.
            $token_pieces = explode(':', $name);
            if (count($token_pieces) >= 2) {
              $fieldname = $token_pieces[0];
              array_shift($token_pieces);
              $output_format = implode(':', $token_pieces);
              if (UcAddressesSchemaAddress::fieldExists($fieldname)) {

                // Check if this field supports the specified output format.
                $handler = uc_addresses_get_address_field_handler($address, $fieldname, 'token');
              }
            }
          }
          if ($handler instanceof UcAddressesFieldHandler) {

            // Use the handler to output the right value.
            $replacements[$original] = $handler
              ->outputValue($address
              ->getField($fieldname), $output_format);
          }
        }
      }
      break;
    case 'uc_order':
      if (empty($data['uc_order'])) {

        // No order object, can happen. RulesTokenEvaluator sometimes sends empty data.
        // Found this out after a long debug session in the automated tests.
        return array();
      }
      $order = $data['uc_order'];
      $order_tokens = array(
        'billing' => 'uc-addresses-billing-address',
        'shipping' => 'uc-addresses-shipping-address',
      );
      foreach ($order_tokens as $address_type => $token) {
        $address_tokens = token_find_with_prefix($tokens, $token);
        if (!isset($tokens[$token]) && !$address_tokens) {
          continue;
        }
        if (isset($order->uc_addresses[$address_type]) && $order->uc_addresses[$address_type] instanceof UcAddressesAddress) {
          $address = $order->uc_addresses[$address_type];
          if (isset($tokens[$token])) {
            $replacements[$tokens[$token]] = uc_addresses_format_address($address, 'token');
          }
          if ($address_tokens) {
            $replacements += token_generate('uc_addresses', $address_tokens, array(
              'uc_addresses' => $address,
            ), $options);
          }
        }
      }
      break;
    case 'user':
      $user = $data['user'];
      $user_tokens = array(
        'billing' => 'default-billing-address',
        'shipping' => 'default-shipping-address',
      );
      foreach ($user_tokens as $address_type => $token) {
        $address_tokens = token_find_with_prefix($tokens, $token);
        if (!isset($tokens[$token]) && !$address_tokens) {
          continue;
        }
        $address = UcAddressesAddressBook::get($user)
          ->getDefaultAddress($address_type);
        if (!$address) {
          continue;
        }
        if (isset($tokens[$token])) {
          $replacements[$tokens[$token]] = uc_addresses_format_address($address, 'token');
        }
        if ($address_tokens) {
          $replacements += token_generate('uc_addresses', $address_tokens, array(
            'uc_addresses' => $address,
          ), $options);
        }
      }
      break;
  }
  return $replacements;
}

Functions

Name	Description
uc_addresses_tokens	Implements hook_tokens().
uc_addresses_token_info	Implements hook_token_info().
uc_addresses_token_info_alter	Implements hook_token_info_alter().