ICanBoogie/CLDR v1.6.0
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • CLDR

Classes

  • Calendar
  • CalendarCollection
  • ContextTransforms
  • 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 
<?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;

/**
 * Representation of a territory collection.
 *
 * ```php
 * <?php
 *
 * $territories = new TerritoryCollection($cldr);
 * # or
 * $territories = $cldr->territories;
 *
 * // check if a territory is defined
 * isset($territories['FR']);          // true
 * isset($territories['UnDiFiNeD']);   // false
 */
class TerritoryCollection implements \ArrayAccess
{
    use AccessorTrait;
    use RepositoryPropertyTrait;
    use CollectionTrait;

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

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

    /**
     * Checks if a territory is defined.
     *
     * @param string $code Territory ISO code.
     *
     * @return bool `true` if the territory is defined, `false` otherwise.
     */
    public function offsetExists($code)
    {
        $supplemental = $this->repository->supplemental;

        return isset($supplemental['territoryInfo'][$code])
        || isset($supplemental['territoryContainment'][$code]);
    }

    /**
     * Returns a territory.
     *
     * @param string $code Territory ISO code.
     *
     * @return Territory
     */
    public function offsetGet($code)
    {
        if (empty($this->collection[$code]))
        {
            $this->collection[$code] = new Territory($this->repository, $code);
        }

        return $this->collection[$code];
    }

    /**
     * Asserts that a territory is defined.
     *
     * @param string $code
     *
     * @throws TerritoryNotDefined if the specified territory is not defined.
     */
    public function assert_defined($code)
    {
        if (isset($this[$code]))
        {
            return;
        }

        throw new TerritoryNotDefined($code);
    }
}
ICanBoogie/CLDR v1.6.0 API documentation generated by ApiGen