1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 <?php
namespace Punic;
/**
* Currency-related stuff.
*/
class Currency
{
/**
* Returns all the currencies.
*
* @param bool $alsoUnused Set to true to receive also currencies not currently used by any country, false otherwise
* @param bool $alsoNotTender Set to true to receive also currencies that aren't legal tender in any country
* @param string $locale The locale to use. If empty we'll use the default locale set with {@link \Punic\Data::setDefaultLocale()}.
*
* @return array Array keys are the currency code, array values are the currency name. It's sorted by currency values
*/
public static function getAllCurrencies($alsoUnused = false, $alsoNotTender = false, $locale = '')
{
$result = array();
foreach (Data::get('currencies', $locale) as $code => $info) {
$result[$code] = $info['name'];
}
if ((!$alsoUnused) || (!$alsoNotTender)) {
$data = Data::getGeneric('currencyData');
$usedCurrencies = array();
$tenderCurrencies = array();
foreach ($data['regions'] as $usages) {
foreach ($usages as $usage) {
if (!isset($usage['to'])) {
$usedCurrencies[$usage['currency']] = true;
}
if ((!isset($usage['notTender'])) || (!$usage['notTender'])) {
$tenderCurrencies[$usage['currency']] = true;
}
}
}
if (!$alsoUnused) {
$result = array_intersect_key($result, $usedCurrencies);
}
if (!$alsoNotTender) {
$result = array_intersect_key($result, $tenderCurrencies);
}
}
return $result;
}
/**
* Returns the name of a currency given its code.
*
* @param string $currencyCode The currency code
* @param null|number|string $quantity The quantity identifier. Allowed values:
* <ul>
* <li>`null` to return the standard name, not associated to any quantity</li>
* <li>`number` to return the name following the plural rule for the specified quantity</li>
* <li>string `'zero'|'one'|'two'|'few'|'many'|'other'` the plural rule
* </ul>
* @param string $locale The locale to use. If empty we'll use the default locale set with {@link \Punic\Data::setDefaultLocale()}.
*
* @return string Returns an empty string if $currencyCode is not valid, the localized currency name otherwise
*/
public static function getName($currencyCode, $quantity = null, $locale = '')
{
$result = '';
$data = static::getLocaleData($currencyCode, $locale);
if (is_array($data)) {
$result = $data['name'];
if (($quantity !== null) && isset($data['pluralName'])) {
if (in_array($quantity, array('zero', 'one', 'two', 'few', 'many', 'other'))) {
$pluralRule = $quantity;
} else {
$pluralRule = Plural::getRule($quantity, $locale);
}
if (!isset($data['pluralName'][$pluralRule])) {
$pluralRule = 'other';
}
$result = $data['pluralName'][$pluralRule];
}
}
return $result;
}
/**
* Returns the name of a currency given its code.
*
* @param string $currencyCode The currency code
* @param string $which Which symbol flavor do you prefer? 'narrow' for narrow symbols, 'alt' for alternative. Other values: standard/default symbol
* @param string $locale The locale to use. If empty we'll use the default locale set with {@link \Punic\Data::setDefaultLocale()}.
*
* @return string Returns an empty string if $currencyCode is not valid, the localized currency name otherwise
*/
public static function getSymbol($currencyCode, $which = '', $locale = '')
{
$result = '';
$data = static::getLocaleData($currencyCode, $locale);
if (is_array($data)) {
switch ($which) {
case 'narrow':
if (isset($data['symbolNarrow'])) {
$result = $data['symbolNarrow'];
}
break;
case 'alt':
if (isset($data['symbolAlt'])) {
$result = $data['symbolAlt'];
}
break;
}
if ($result === '' && $which !== 'alt') {
if (isset($data['symbol'])) {
$result = $data['symbol'];
}
if ($result === '') {
$result = $currencyCode;
}
}
}
return $result;
}
/**
* Return the history for the currencies used in a territory.
*
* @param string $territoryCode The territoy code
*
* @return array Return a list of items with these keys:
* <ul>
* <li>string `currency`: the currency code (always present)</li>
* <li>string `from`: start date of the currency validity in the territory (not present if no start date) - Format is YYYY-MM-DD</li>
* <li>string `to`: end date of the currency validity in the territory (not present if no end date) - Format is YYYY-MM-DD</li>
* <li>bool `tender`: true if the currency was or is legal tender, false otherwise (always present)</li>
* </ul>
*/
public static function getCurrencyHistoryForTerritory($territoryCode)
{
$result = array();
if (preg_match('/^[A-Z]{2}|[0-9]{3}$/', $territoryCode)) {
$data = Data::getGeneric('currencyData');
if (isset($data['regions'][$territoryCode])) {
foreach ($data['regions'][$territoryCode] as $c) {
if (isset($c['notTender'])) {
$c['tender'] = !$c['notTender'];
unset($c['notTender']);
} else {
$c['tender'] = true;
}
$result[] = $c;
}
}
}
return $result;
}
/**
* Return the currency to be used in a territory.
*
* @param string $territoryCode The territoy code
*
* @return string Returns an empty string if $territoryCode is not valid or we don't have info about it, the currency code otherwise
*/
public static function getCurrencyForTerritory($territoryCode)
{
$result = '';
$history = static::getCurrencyHistoryForTerritory($territoryCode);
if (!empty($history)) {
$today = @date('Y-m-d');
foreach ($history as $c) {
if ((!isset($c['to'])) || (strcmp($c['to'], $today) >= 0)) {
$result = $c['currency'];
if ($c['tender']) {
break;
}
}
}
}
return $result;
}
/**
* @param string $currencyCode
* @param string $locale
*
* @return array|null
*/
protected static function getLocaleData($currencyCode, $locale)
{
$result = null;
if (is_string($currencyCode) && (strlen($currencyCode) === 3)) {
$data = Data::get('currencies', $locale);
if (isset($data[$currencyCode])) {
$result = $data[$currencyCode];
}
}
return $result;
}
}