Locale::Currency(3)

📦
version 3.790.0 · 15 versions
, in opensuse-leap 16.0

💖 NAME 💖

okay bestie, welcome to the User Contributed Perl Documentation for Locale::Currency(3) — this is the Locale::Currency module, and it is literally for dealing with currency code sets. slay.

✨ SYNOPSIS ✨

like, the whole vibe in four lines:

use Locale::Currency;

$name = code2currency(CODE);
$code = currency2code(NAME);

@codes   = all_currency_codes();
@names   = all_currency_names();

🦋 DESCRIPTION 🦋

This module provides access to currency code sets. no cap.

Please refer to the Locale::Codes::Types document for a description of the code sets available. that’s where the code-set tea lives.

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. easy.

💅 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
  • code2currencys(CODE [,CODESET]) — see code2names 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. periodt.
  • 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 👀

  • Locale::Codes — The Locale-Codes distribution.

🌸 AUTHOR 🌸

See Locale::Codes for full author history.

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

Copyright (c) 2011-2024 Sullivan Beck

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

okay bye bestie, this doc is from perl v5.42.0, dated 2024-06-23 — mwah 💅✨

📦 where this page comes from