function uc_recurring_token_info in UC Recurring Payments and Subscriptions 7.2

Implements hook_token_info().

File

./uc_recurring.tokens.inc, line 11

Token related functions for the Ubercart recurring payments module.

Code

function uc_recurring_token_info() {
  $types = array();
  $tokens = array();
  $types['uc_recurring_fee'] = array(
    'name' => t('Recurring fees'),
    'description' => t('Tokens related to Ubercart Recurring fees.'),
    'needs-data' => 'uc_recurring_fee',
  );
  $tokens['uc_recurring_fee'] = array(
    'recurring-fee-id' => array(
      'name' => t('Recurring fee ID'),
      'description' => t('The recurring fee ID.'),
    ),
    'next-charge' => array(
      'name' => t('Next charge'),
      'description' => t('The date and time when the next charge is due to be processed.'),
      'type' => 'date',
    ),
    'fee-amount' => array(
      'name' => t('Fee amount'),
      'description' => t('The recurring fee amount due on the next charge.'),
    ),
    'fee-title' => array(
      'name' => t('Fee title'),
      'description' => t('The product title used as orders for this recurring fee.'),
    ),
    'charged-intervals' => array(
      'name' => t('Charged intervals'),
      'description' => t('The number of recurring intervals that have been charged so far.'),
    ),
    'remaining-intervals' => array(
      'name' => t('Remaining intervals'),
      'description' => t('The number of recurring intervals due left in subscription.'),
    ),
    'renewal-attempts' => array(
      'name' => t('Renewal attempts'),
      'description' => t('The number of attempts to try and renew this fee.'),
    ),
    'link' => array(
      'name' => t('Link'),
      'description' => t('A link to the recurring fee using the recurring fee ID as the text.'),
    ),
    'url' => array(
      'name' => t('URL'),
      'description' => t('The URL to the recurring fee.'),
      'type' => 'url',
    ),
  );
  return array(
    'types' => $types,
    'tokens' => $tokens,
  );
}