currency.api.php in Currency 7.2

API documentation.

File

currency/currency.api.php

<?php

/**
 * @file
 * API documentation.
 */

/**
 * Expose currencies.
 *
 * @return array
 *   An array of Currency objects, keyed by their currency codes.
 */
function hook_currency_info() {
  $currencies['EUR'] = new Currency(array(
    'ISO4217Code' => 'EUR',
    'sign' => '€',
    'subunits' => 100,
    'title' => t('Euro'),
  ));
  return $currencies;
}

/**
 * Alter exposed currencies.
 *
 * @param array
 *   An array of Currency objects, keyed by their currency codes.
 *
 * @return NULL
 */
function hook_currency_info_alter(array $currencies) {

  // Let's pretend the euro has 1000 subunits.
  $currencies['EUR']['subunits'] = 1000;
}

/**
 * Expose CLDR number patterns for locales.
 *
 * @return array
 *   An array of CurrencyLocalePattern objects, keyed by their locales.
 */
function hook_currency_locale_pattern_info() {
  $locale_patterns['nl_NL'] = new CurrencyLocalePattern(array(
    'locale' => 'nl_NL',
    'pattern' => '¤#.##0,0#',
  ));
  return $locale_patterns;
}

/**
 * Alter exposed currency locale patterns.
 *
 * @param array
 *   An array of CurrencyLocalePattern objects, keyed by their locales.
 *
 * @return NULL
 */
function hook_currency_locale_pattern_info_alter(array $locale_patterns) {
  $locale_patterns['nl_NL']->pattern = '¤ #.##0,0#';
}

/**
 * Expose currency exchangers.
 *
 * Currency exchangers are Ctools plugins. As such, this hook is a Ctools
 * plugin hook.
 *
 * @return array
 *   Keys are plugin machine names. Values are arrays with two items:
 *   - exchanger: an array with a "class" key, which contains the name of the
 *     exchanger class, which should implement CurrencyExchangerInterface.
 *   - title: the translated human-readable title. Defaults to TRUE.
 */
function hook_currency_exchanger_info() {
  $currency_exchangers['CurrencyExchangerFixedRates'] = array(
    'exchanger' => array(
      'class' => 'CurrencyExchangerFixedRates',
    ),
    'title' => t('Fixed rates'),
  );
  return $currency_exchangers;
}

Functions

Name	Description
hook_currency_exchanger_info	Expose currency exchangers.
hook_currency_info	Expose currencies.
hook_currency_info_alter	Alter exposed currencies.
hook_currency_locale_pattern_info	Expose CLDR number patterns for locales.
hook_currency_locale_pattern_info_alter	Alter exposed currency locale patterns.