Perl 5 version documentation

Locale::Currency

NAME

Locale::Currency - module for dealing with currency code sets

SYNOPSIS

  1.    use Locale::Currency;
  3.    $name = code2currency(CODE);
  4.    $code = currency2code(NAME);
  6.    @codes   = all_currency_codes();
  7.    @names   = all_currency_names();

DESCRIPTION

This module provides access to currency code sets.

Please refer to the Locale::Codes::Types document for a description of the code sets available.

Most of the routines take an optional additional argument which specifies the code set to use. The code set can be specified using the name of a code set, or the perl constant specified in the above document. If not specified, the default code set will be used.

ROUTINES

All routines in this module call the appropriate method in the Locale::Codes module, using an object of type: currency Please refer to the documentation of the Locale::Codes module for details about each function.

The following functions are exported automatically:

  • code2currency(CODE [,CODESET] [,'retired'])

    See code2name in Locale::Codes

  • currency2code(NAME [,CODESET] [,'retired'])

    See name2code in Locale::Codes

  • currency_code2code(CODE ,CODESET ,CODESET2)

    See code2code in Locale::Codes

  • all_currency_codes([CODESET] [,'retired'])

    See all_codes in Locale::Codes

  • all_currency_names([CODESET] [,'retired'])

    See all_names in Locale::Codes

The following functions are not exported and must be called fully qualified with the package name:

  • Locale::Currency::show_errors(FLAG)

    By default, invalid input will produce empty results, but no errors. By passing in a non-zero value of FLAG, errors will be produced.

    See show_errors in Locale::Codes but note that the default for the non-OO modules are to NOT produce errors.

  • Locale::Currency::rename_currency(CODE ,NEW_NAME [,CODESET])

    See rename_code in Locale::Codes

  • Locale::Currency::add_currency(CODE ,NAME [,CODESET])

    See add_code in Locale::Codes

  • Locale::Currency::delete_currency(CODE [,CODESET])

    See delete_code in Locale::Codes

  • Locale::Currency::add_currency_alias(NAME ,NEW_NAME)

    See add_alias in Locale::Codes

  • Locale::Currency::delete_currency_alias(NAME)

    See delete_alias in Locale::Codes

  • Locale::Currency::rename_currency_code(CODE ,NEW_CODE [,CODESET])

    See replace_code in Locale::Codes

  • Locale::Currency::add_currency_code_alias(CODE ,NEW_CODE [,CODESET])

    See add_code_alias in Locale::Codes

  • Locale::Currency::delete_currency_code_alias(CODE [,CODESET])

    See delete_code_alias in Locale::Codes

SEE ALSO

AUTHOR

See Locale::Codes for full author history.

Currently maintained by Sullivan Beck (sbeck@cpan.org).

COPYRIGHT

  1.    Copyright (c) 2011-2018 Sullivan Beck

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.