Cldr Territories v2.0.1 TestBackend.Cldr.Territory View Source

Link to this section Summary

Functions

Returns a list of available styles

Returns the available territories for a given locale

The same as children/2, but raises an exception if it fails

Lists children(s) for the given territory code. Returns {:ok, list} if successful, otherwise {:error, reason}

Checks relationship between two territories, where the first argument is the parent and second the child. Returns true if successful, otherwise false

Returns a list of country codes

The same as from_language_tag/2, but raises an exception if it fails

Localized string for the given LanguageTag.t. Returns {:ok, String.t} if successful, otherwise {:error, reason}

Localized string for the given territory code. Returns {:ok, String.t} if successful, otherwise {:error, reason}

The same as info/1, but raises an exception if it fails

Maps territory info for the given territory code. Returns {:ok, map} if successful, otherwise {:error, reason}

Returns a map of all known territories in a given locale

The same as parent/2, but raises an exception if it fails

Lists parent(s) for the given territory code. Returns {:ok, list} if successful, otherwise {:error, reason}

The same as to_currency_code/2, but raises an exception if it fails

A helper method to get a territory’s currency code if a territory has multiply currencies then the oldest active currency is returned. Returns {:ok, code} if successful, otherwise {:error, reason}

The same as to_currency_codes/2, but raises an exception if it fails

A helper method to get a territory’s currency codes. Returns {:ok, list} if successful, otherwise {:error, reason}

The same as to_unicode_flag/1, but raises an exception if it fails

Unicode flag for the given territory code. Returns {:ok, flag} if successful, otherwise {:error, reason}

Translate a LanguageTag.t into a localized string from one locale to another. Returns {:ok, result} if successful, otherwise {:error, reason}

Translate a localized string from one locale to another. Returns {:ok, result} if successful, otherwise {:error, reason}

Link to this section Functions

Link to this function available_styles() View Source
available_styles() :: [:short | :standard | :variant]

Returns a list of available styles.

Example

iex> TestBackend.Cldr.Territory.available_styles()
[:short, :standard, :variant]
Link to this function available_territories(locale \\ TestBackend.Cldr.get_locale()) View Source
available_territories(Cldr.Territory.binary_tag()) ::
  [atom()] | {:error, Cldr.Territory.error()}

Returns the available territories for a given locale.

Example

=> TestBackend.Cldr.Territory.available_territories()
[:"001", :"002", :"003", :"005", :"009", :"011", :"013", :"014", :"015", :"017",
:"018", :"019", :"021", :"029", :"030", :"034", :"035", :"039", :"053", :"054",
:"057", :"061", :"142", :"143", :"145", :"150", :"151", :"154", :"155", :"202",
:"419", :AC, :AD, :AE, :AF, :AG, :AI, :AL, :AM, :AO, :AQ, :AR, :AS, :AT, :AU,
:AW, :AX, :AZ, :BA, :BB, ...]

=> TestBackend.Cldr.Territory.available_territories("zzz")
{:error, {Cldr.UnknownLocaleError, "The locale "zzz" is not known."}}

The same as children/2, but raises an exception if it fails.

  • options are:

    • as: :atom
    • as: :binary
    • as: :charlist

Example

iex> TestBackend.Cldr.Territory.children!(:EU)
[:AT, :BE, :CY, :CZ, :DE, :DK, :EE, :ES, :FI, :FR, :GB, :GR, :HR, :HU, :IE, :IT,
:LT, :LU, :LV, :MT, :NL, :PL, :PT, :SE, :SI, :SK, :BG, :RO]

Lists children(s) for the given territory code. Returns {:ok, list} if successful, otherwise {:error, reason}.

  • options are:

    • as: :atom
    • as: :binary
    • as: :charlist

Example

iex> TestBackend.Cldr.Territory.children(:EU)
{:ok,
[:AT, :BE, :CY, :CZ, :DE, :DK, :EE, :ES, :FI, :FR, :GB, :GR, :HR, :HU, :IE,
  :IT, :LT, :LU, :LV, :MT, :NL, :PL, :PT, :SE, :SI, :SK, :BG, :RO]}

iex> TestBackend.Cldr.Territory.children(:ZZZ)
{:error, {Cldr.UnknownTerritoryError, "The territory :ZZZ is unknown"}}

iex> TestBackend.Cldr.Territory.children(:GB)
{:error, {Cldr.UnknownParentError, "The territory :GB has no children"}}

Checks relationship between two territories, where the first argument is the parent and second the child. Returns true if successful, otherwise false.

Example

iex> TestBackend.Cldr.Territory.contains?(:EU, :DK)
true

iex> TestBackend.Cldr.Territory.contains?(:DK, :EU)
false

Returns a list of country codes.

  • options are:

    • as: :atom
    • as: :binary
    • as: :charlist

Example

=> TestBackend.Cldr.Territory.country_codes()
[:AD, :AE, :AF, :AG, :AI, :AL, :AM, :AO, :AR, :AS, :AT, :AU, :AW,
:AX, :AZ, :BA, :BB, :BD, :BE, :BF, :BG, :BH, :BI, :BJ, :BL, :BM,
:BN, :BO, :BQ, :BR, :BS, :BT, :BV, :BW, :BY, :BZ, :CA, :CC, :CD,
:CF, :CG, :CH, :CI, :CK, :CL, :CM, :CN, :CO, :CR, :CU, ...]
Link to this function from_language_tag!(tag, options \\ [style: :standard]) View Source
from_language_tag!(Cldr.Territory.tag(), Cldr.Territory.options()) ::
  binary() | no_return()

The same as from_language_tag/2, but raises an exception if it fails.

Example

iex> TestBackend.Cldr.Territory.from_language_tag!(Cldr.get_locale())
"World"
Link to this function from_language_tag(tag, options \\ [style: :standard]) View Source
from_language_tag(Cldr.Territory.tag(), Cldr.Territory.options()) ::
  {:ok, binary()} | {:error, Cldr.Territory.error()}

Localized string for the given LanguageTag.t. Returns {:ok, String.t} if successful, otherwise {:error, reason}.

Example

iex> TestBackend.Cldr.Territory.from_language_tag(Cldr.get_locale())
{:ok, "World"}

iex> TestBackend.Cldr.Territory.from_language_tag(Cldr.get_locale(), [style: :short])
{:error, {Cldr.UnknownStyleError, "The style :short is unknown"}}

iex> TestBackend.Cldr.Territory.from_language_tag(Cldr.get_locale(), [style: :ZZZ])
{:error, {Cldr.UnknownStyleError, "The style :ZZZ is unknown"}}

iex> TestBackend.Cldr.Territory.from_language_tag(Cldr.get_locale(), [style: "ZZZ"])
{:error, {Cldr.UnknownStyleError, "The style \"ZZZ\" is unknown"}}
Link to this function from_territory_code!(territory_code, options \\ [locale: TestBackend.Cldr.get_locale(), style: :standard]) View Source

The same as from_territory_code/2, but raises an exception if it fails.

Example

iex> TestBackend.Cldr.Territory.from_territory_code!(:GB)
"United Kingdom"

iex> TestBackend.Cldr.Territory.from_territory_code!(:GB, [style: :short])
"UK"

iex> TestBackend.Cldr.Territory.from_territory_code!(:GB, [locale: "pt"])
"Reino Unido"
Link to this function from_territory_code(territory_code, options \\ [locale: TestBackend.Cldr.get_locale(), style: :standard]) View Source
from_territory_code(Cldr.Territory.atom_binary_tag(), Cldr.Territory.options()) ::
  {:ok, binary()} | {:error, Cldr.Territory.error()}

Localized string for the given territory code. Returns {:ok, String.t} if successful, otherwise {:error, reason}.

Example

iex> TestBackend.Cldr.Territory.from_territory_code(:GB)
{:ok, "United Kingdom"}

iex> TestBackend.Cldr.Territory.from_territory_code(:GB, [style: :short])
{:ok, "UK"}

iex> TestBackend.Cldr.Territory.from_territory_code(:GB, [style: :ZZZ])
{:error, {Cldr.UnknownStyleError, "The style :ZZZ is unknown"}}

iex> TestBackend.Cldr.Territory.from_territory_code(:GB, [style: "ZZZ"])
{:error, {Cldr.UnknownStyleError, "The style \"ZZZ\" is unknown"}}

iex> TestBackend.Cldr.Territory.from_territory_code(:GB, [locale: "pt"])
{:ok, "Reino Unido"}

iex> TestBackend.Cldr.Territory.from_territory_code(:GB, [locale: :zzz])
{:error, {Cldr.UnknownLocaleError, "The locale :zzz is not known."}}

iex> TestBackend.Cldr.Territory.from_territory_code(:GB, [locale: "zzz"])
{:error, {Cldr.UnknownLocaleError, "The locale \"zzz\" is not known."}}

The same as info/1, but raises an exception if it fails.

Example

iex> TestBackend.Cldr.Territory.info!(:GB)
%{currency: [GBP: %{from: ~D[1694-07-27]}], gdp: 2788000000000,
            language_population: %{"bn" => %{population_percent: 0.67},
              "cy" => %{official_status: "official_regional",
                population_percent: 0.77}, "de" => %{population_percent: 6},
              "el" => %{population_percent: 0.34},
              "en" => %{official_status: "official", population_percent: 99},
              "fr" => %{population_percent: 19},
              "ga" => %{official_status: "official_regional",
                population_percent: 0.026},
              "gd" => %{official_status: "official_regional",
                population_percent: 0.099, writing_percent: 5},
              "it" => %{population_percent: 0.34},
              "ks" => %{population_percent: 0.19},
              "kw" => %{population_percent: 0.0031},
              "ml" => %{population_percent: 0.035},
              "pa" => %{population_percent: 0.79},
              "sco" => %{population_percent: 2.7, writing_percent: 5},
              "syl" => %{population_percent: 0.51},
              "yi" => %{population_percent: 0.049},
              "zh-Hant" => %{population_percent: 0.54}}, literacy_percent: 99,
            measurement_system: "UK", paper_size: "A4", population: 64769500,
            telephone_country_code: 44, temperature_measurement: "metric"}
Link to this function info(territory_code) View Source
info(Cldr.Territory.atom_tag()) ::
  {:ok, map()} | {:error, Cldr.Territory.error()}

Maps territory info for the given territory code. Returns {:ok, map} if successful, otherwise {:error, reason}.

Example

iex> TestBackend.Cldr.Territory.info(:GB)
{:ok, %{currency: [GBP: %{from: ~D[1694-07-27]}], gdp: 2788000000000,
      language_population: %{"bn" => %{population_percent: 0.67},
        "cy" => %{official_status: "official_regional",
          population_percent: 0.77}, "de" => %{population_percent: 6},
        "el" => %{population_percent: 0.34},
        "en" => %{official_status: "official", population_percent: 99},
        "fr" => %{population_percent: 19},
        "ga" => %{official_status: "official_regional",
          population_percent: 0.026},
        "gd" => %{official_status: "official_regional",
          population_percent: 0.099, writing_percent: 5},
        "it" => %{population_percent: 0.34},
        "ks" => %{population_percent: 0.19},
        "kw" => %{population_percent: 0.0031},
        "ml" => %{population_percent: 0.035},
        "pa" => %{population_percent: 0.79},
        "sco" => %{population_percent: 2.7, writing_percent: 5},
        "syl" => %{population_percent: 0.51},
        "yi" => %{population_percent: 0.049},
        "zh-Hant" => %{population_percent: 0.54}}, literacy_percent: 99,
      measurement_system: "UK", paper_size: "A4", population: 64769500,
      telephone_country_code: 44, temperature_measurement: "metric"}}
Link to this function known_territories(locale \\ TestBackend.Cldr.get_locale()) View Source
known_territories(Cldr.Territory.binary_tag()) ::
  map() | {:error, Cldr.Territory.error()}

Returns a map of all known territories in a given locale.

Example

=> TestBackend.Cldr.Territory.known_territories()
%{SN: %{standard: "Senegal"}, "061": %{standard: "Polynesia"},
BH: %{standard: "Bahrain"}, TM: %{standard: "Turkmenistan"},
"009": %{standard: "Oceania"}, CW: %{standard: "Curaçao"},
FR: %{standard: "France"}, TN: %{standard: "Tunisia"},
FI: %{standard: "Finland"}, BF: %{standard: "Burkina Faso"},
"155": %{standard: "Western Europe"}, GL: %{standard: "Greenland"},
VI: %{standard: "U.S. Virgin Islands"}, ZW: %{standard: "Zimbabwe"},
AR: %{standard: "Argentina"}, SG: %{standard: "Singapore"},
SZ: %{standard: "Swaziland"}, ID: %{standard: "Indonesia"},
NR: %{standard: "Nauru"}, RW: %{standard: "Rwanda"},
TR: %{standard: "Turkey"}, IS: %{standard: "Iceland"},
ME: %{standard: "Montenegro"}, AW: %{standard: "Aruba"},
PY: %{standard: "Paraguay"}, "145": %{standard: "Western Asia"},
CG: %{standard: "Congo - Brazzaville", variant: "Congo (Republic)"},
LT: %{standard: "Lithuania"}, SA: %{standard: "Saudi Arabia"},
MZ: %{standard: "Mozambique"}, NU: %{standard: "Niue"},
NG: %{standard: "Nigeria"}, CK: %{standard: "Cook Islands"},
ZM: %{standard: "Zambia"}, LK: %{standard: "Sri Lanka"},
UY: %{standard: "Uruguay"}, YE: %{standard: "Yemen"},
"011": %{standard: "Western Africa"},
CC: %{standard: "Cocos (Keeling) Islands"}, BY: %{standard: "Belarus"},
IL: %{standard: "Israel"}, KY: %{standard: "Cayman Islands"},
GN: %{standard: "Guinea"}, VN: %{standard: "Vietnam"},
PE: %{standard: "Peru"}, HU: %{standard: "Hungary"},
HN: %{standard: "Honduras"}, GI: %{standard: "Gibraltar"},
"142": %{standard: "Asia"}, "029": %{...}, ...}

=> TestBackend.Cldr.Territory.known_territories("zzz")
{:error, {Cldr.UnknownLocaleError, "The locale "zzz" is not known."}}

The same as parent/2, but raises an exception if it fails.

  • options are:

    • as: :atom
    • as: :binary
    • as: :charlist

Example

iex> TestBackend.Cldr.Territory.parent!(:GB)
[:"154", :EU, :UN]

Lists parent(s) for the given territory code. Returns {:ok, list} if successful, otherwise {:error, reason}.

  • options are:

    • as: :atom
    • as: :binary
    • as: :charlist

Example

iex> TestBackend.Cldr.Territory.parent(:GB)
{:ok, [:"154", :EU, :UN]}

iex> TestBackend.Cldr.Territory.parent(:ZZZ)
{:error, {Cldr.UnknownTerritoryError, "The territory :ZZZ is unknown"}}

iex> TestBackend.Cldr.Territory.parent(Cldr.get_locale())
{:error, {Cldr.UnknownChildrenError, "The territory :\"001\" has no parent(s)"}}
Link to this function to_currency_code!(territory_code, opts \\ [as: :atom]) View Source

The same as to_currency_code/2, but raises an exception if it fails.

  • options are:

    • as: :atom
    • as: :binary
    • as: :charlist

Example

iex> TestBackend.Cldr.Territory.to_currency_code!(:US)
:USD

iex> TestBackend.Cldr.Territory.to_currency_code!(:US, as: :charlist)
'USD'

iex> TestBackend.Cldr.Territory.to_currency_code!("PS")
:ILS

iex> TestBackend.Cldr.Territory.to_currency_code!("PS", as: :binary)
"ILS"
Link to this function to_currency_code(territory_code, opts \\ [as: :atom]) View Source

A helper method to get a territory’s currency code if a territory has multiply currencies then the oldest active currency is returned. Returns {:ok, code} if successful, otherwise {:error, reason}.

  • options are:

    • as: :atom
    • as: :binary
    • as: :charlist

Example

iex> TestBackend.Cldr.Territory.to_currency_code(:US)
{:ok, :USD}

iex> TestBackend.Cldr.Territory.to_currency_code("cu")
{:ok, :CUP}
Link to this function to_currency_codes!(territory_code, opts \\ [as: :atom]) View Source

The same as to_currency_codes/2, but raises an exception if it fails.

  • options are:

    • as: :atom
    • as: :binary
    • as: :charlist

Example

iex> TestBackend.Cldr.Territory.to_currency_codes!(:US)
[:USD]

iex> TestBackend.Cldr.Territory.to_currency_codes!(:US, as: :charlist)
['USD']

iex> TestBackend.Cldr.Territory.to_currency_codes!("PS")
[:ILS, :JOD]

iex> TestBackend.Cldr.Territory.to_currency_codes!("PS", as: :binary)
["ILS", "JOD"]
Link to this function to_currency_codes(territory_code, opts \\ [as: :atom]) View Source

A helper method to get a territory’s currency codes. Returns {:ok, list} if successful, otherwise {:error, reason}.

  • options are:

    • as: :atom
    • as: :binary
    • as: :charlist

Example

iex> TestBackend.Cldr.Territory.to_currency_codes(:US)
{:ok, [:USD]}

iex> TestBackend.Cldr.Territory.to_currency_codes("cu")
{:ok, [:CUP, :CUC]}
Link to this function to_unicode_flag!(territory_code) View Source
to_unicode_flag!(Cldr.Territory.atom_binary_tag()) :: binary() | no_return()

The same as to_unicode_flag/1, but raises an exception if it fails.

Example

iex> TestBackend.Cldr.Territory.to_unicode_flag!(:US)
"🇺🇸"
Link to this function to_unicode_flag(territory_code) View Source
to_unicode_flag(
  Cldr.Territory.atom_binary_tag()
  | {:ok, atom()}
  | {:error, Cldr.Territory.error()}
) :: {:ok, binary()} | {:error, Cldr.Territory.error()}

Unicode flag for the given territory code. Returns {:ok, flag} if successful, otherwise {:error, reason}.

Example

iex> TestBackend.Cldr.Territory.to_unicode_flag(:US)
{:ok, "🇺🇸"}

iex> TestBackend.Cldr.Territory.to_unicode_flag(:EZ)
{:error, {Cldr.UnknownFlagError, "The territory :EZ has no flag"}}
Link to this function translate_language_tag!(locale_from, options \\ [locale: TestBackend.Cldr.get_locale(), style: :standard]) View Source
translate_language_tag!(Cldr.Territory.tag(), Cldr.Territory.options()) ::
  binary() | no_return()

The same as translate_language_tag/2, but raises an exception if it fails.

Example

iex> TestBackend.Cldr.Territory.translate_language_tag!(Cldr.get_locale())
"World"

iex> TestBackend.Cldr.Territory.translate_language_tag!(Cldr.get_locale(), [locale: Cldr.Locale.new!("pt", TestBackend.Cldr)])
"Mundo"
Link to this function translate_language_tag(from_locale, options \\ [locale: TestBackend.Cldr.get_locale(), style: :standard]) View Source
translate_language_tag(Cldr.Territory.tag(), Cldr.Territory.options()) ::
  {:ok, binary()} | {:error, Cldr.Territory.error()}

Translate a LanguageTag.t into a localized string from one locale to another. Returns {:ok, result} if successful, otherwise {:error, reason}.

Example

iex> TestBackend.Cldr.Territory.translate_language_tag(Cldr.get_locale())
{:ok, "World"}

iex> TestBackend.Cldr.Territory.translate_language_tag(Cldr.get_locale(), [locale: Cldr.Locale.new!("pt", TestBackend.Cldr)])
{:ok, "Mundo"}
Link to this function translate_territory!(localized_string, from_locale, to_locale \\ TestBackend.Cldr.get_locale()) View Source

The same as translate_territory/3, but raises an exception if it fails.

Example

iex> TestBackend.Cldr.Territory.translate_territory!("Reino Unido", "pt")
"UK"

iex> TestBackend.Cldr.Territory.translate_territory!("United Kingdom", "en", "pt")
"Reino Unido"
Link to this function translate_territory(localized_string, from_locale, to_locale \\ TestBackend.Cldr.get_locale()) View Source
translate_territory(
  binary(),
  Cldr.Territory.binary_tag(),
  Cldr.Territory.binary_tag()
) :: {:ok, binary()} | {:error, Cldr.Territory.error()}

Translate a localized string from one locale to another. Returns {:ok, result} if successful, otherwise {:error, reason}.

Example

iex> TestBackend.Cldr.Territory.translate_territory("Reino Unido", "pt")
{:ok, "UK"}

iex> TestBackend.Cldr.Territory.translate_territory("United Kingdom", "en", "pt")
{:ok, "Reino Unido"}

iex> TestBackend.Cldr.Territory.translate_territory("Reino Unido", :zzz)
{:error, {Cldr.UnknownLocaleError, "The locale :zzz is not known."}}

iex> TestBackend.Cldr.Territory.translate_territory("United Kingdom", "en", "zzz")
{:error, {Cldr.UnknownLocaleError, "The locale \"zzz\" is not known."}}