Locale:...Currency(3)

🌈 NAME 🌈

okay bestie, welcome to Locale:...Currency(3) — yes, the User Contributed Perl Documentation one 💅 — and the main character here is Locale::Codes::Currency, aka the module for dealing with currency code sets. No cap. 💖

---

✨ SYNOPSIS ✨

use Locale::Codes::Currency;

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

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

---

🦋 DESCRIPTION 🦋

This module provides access to currency code sets. It's giving "I speak fluent currency codes" energy, fr fr. 💸✨

Please refer to the Locale::Codes::Types document for a description of the code sets available. That's where the full lore lives, bestie 📚💖.

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 peasy. 🎀

---

👑 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. Basically: this module is the cute little front desk, and Locale::Codes has the full receipts. 🧾💅

🌸 The following functions are exported automatically 🌸

• code2currency(CODE [,CODESET] [,'retired']) — see code2name in Locale::Codes.
• code2currencys(CODE [,CODESET]) — see code2names in Locale::Codes. yes, it's code2currencys, with the plural s, periodt ✨
• 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::Codes::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 heads up: the default for the non-OO modules is to NOT produce errors. 🚨
• Locale::Codes::Currency::rename_currency(CODE ,NEW_NAME [,CODESET]) — see rename_code in Locale::Codes.
• Locale::Codes::Currency::add_currency(CODE ,NAME [,CODESET]) — see add_code in Locale::Codes.
• Locale::Codes::Currency::delete_currency(CODE [,CODESET]) — see delete_code in Locale::Codes.
• Locale::Codes::Currency::add_currency_alias(NAME ,NEW_NAME) — see add_alias in Locale::Codes.
• Locale::Codes::Currency::delete_currency_alias(NAME) — see delete_alias in Locale::Codes.
• Locale::Codes::Currency::rename_currency_code(CODE ,NEW_CODE [,CODESET]) — see replace_code in Locale::Codes.
• Locale::Codes::Currency::add_currency_code_alias(CODE ,NEW_CODE [,CODESET]) — see add_code_alias in Locale::Codes.
• Locale::Codes::Currency::delete_currency_code_alias(CODE [,CODESET]) — see delete_code_alias in Locale::Codes.

---

🌈 SEE ALSO 🌈

• Locale::Codes — the Locale-Codes distribution. iconic behavior, honestly 👑✨

---

🫶 AUTHOR 🫶

See Locale::Codes for full author history.

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

---

🎀 COPYRIGHT 🎀

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. Slay, open source 💅✨

---

okay that's the whole vibe, bestie 🦋💖 — cute little sign-off: this page comes from source/version perl v5.42.0, dated 2024-06-23, and it's the Locale:...Currency(3) manual page. bye bestie, go handle those currency codes 🫶🌈💜