ICanBoogie/CLDR v1.5.0
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • CLDR

Classes

  • Calendar
  • CalendarCollection
  • Currency
  • CurrencyCollection
  • CurrencyFormatter
  • DateFormatter
  • DateTimeFormatter
  • FileProvider
  • ListFormatter
  • Locale
  • LocaleCollection
  • LocalizedCurrency
  • LocalizedDateTime
  • LocalizedListFormatter
  • LocalizedLocale
  • LocalizedNumberFormatter
  • LocalizedObject
  • LocalizedObjectWithFormatter
  • LocalizedTerritory
  • NumberFormatter
  • NumberPattern
  • NumberPatternParser
  • Numbers
  • ProviderCollection
  • RedisProvider
  • Repository
  • RunTimeProvider
  • Supplemental
  • Territory
  • TerritoryCollection
  • TimeFormatter
  • WebProvider

Interfaces

  • Exception
  • Formatter
  • LocalizeAwareInterface
  • Provider

Traits

  • CodePropertyTrait
  • CollectionTrait
  • LocalePropertyTrait
  • ProviderStorageBinding
  • RepositoryPropertyTrait

Exceptions

  • ResourceNotFound
  • TerritoryNotDefined
  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 
<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\CLDR;

use ICanBoogie\Accessor\AccessorTrait;
use ICanBoogie\OffsetNotDefined;

/**
 * A currency collection.
 *
 * ```php
 * <?php
 *
 * $collection = new CurrencyCollection($repository);
 *
 * isset($collection['EUR']);            // true
 * isset($collection['USD']);            // true
 * isset($collection['ABC']);            // false
 *
 * echo get_class($collection['EUR']);   // ICanBoogie\CLDR\Currency
 * echo $collection['EUR']->code;        // EUR
 * ```
 */
class CurrencyCollection implements \ArrayAccess
{
    use AccessorTrait;
    use RepositoryPropertyTrait;
    use CollectionTrait;

    /**
     * @var Currency[]
     */
    private $collection = [];

    /**
     * @param Repository $repository
     */
    public function __construct(Repository $repository)
    {
        $this->repository = $repository;
    }

    /**
     * Check if a currency is defined.
     *
     * @param string $currency_code
     *
     * @return bool `true` if the currency is defined, `false' otherwise.
     */
    public function offsetExists($currency_code)
    {
        $data = $this->repository->supplemental['currencyData']['region'];

        foreach ($data as $territory_code => $currencies)
        {
            foreach ($currencies as $currency_info)
            {
                $code = key($currency_info);

                if ($code == $currency_code)
                {
                    return true;
                }
            }
        }

        return false;
    }

    /**
     * Return a currency.
     *
     * @param string $currency_code
     *
     * @throw OffsetNotDefined in attempt to obtain a currency that is not defined.
     *
     * @return Currency
     */
    public function offsetGet($currency_code)
    {
        if (isset($this->collection[$currency_code]))
        {
            return $this->collection[$currency_code];
        }

        if (!$this->offsetExists($currency_code))
        {
            throw new OffsetNotDefined([ $currency_code, $this ]);
        }

        return $this->collection[$currency_code] = new Currency($this->repository, $currency_code);
    }
}
ICanBoogie/CLDR v1.5.0 API documentation generated by ApiGen