Cadastre v0.1.1 Cadastre.Subdivision View Source
Subdivision implementation
Link to this section Summary
Functions
Returns subdivisions for country. Returns empty list for invalid argument.
Returns all subdivision ids (ISO_3166-2) for country. Returns empty list for invalid argument.
Returns subdivision name translation for locale
Returns %Cadastre.Subdivision{}
for valid country/country_id and id.
Returns nil
for invalid country/country_id and id.
Link to this section Types
Link to this type
t()
View Sourcet() :: %Cadastre.Subdivision{ country_id: Cadastre.Country.id(), id: id(), name: Cadastre.msgid() }
Link to this section Functions
Link to this function
all(country_or_country_id)
View Sourceall(Cadastre.Country.t() | Cadastre.Country.id() | any()) :: [t()]
Returns subdivisions for country. Returns empty list for invalid argument.
Examples
iex> Cadastre.Subdivision.all("SL")
[
%Cadastre.Subdivision{country_id: "SL", id: "E", name: "Eastern"},
%Cadastre.Subdivision{country_id: "SL", id: "N", name: "Northern"},
%Cadastre.Subdivision{country_id: "SL", id: "S", name: "Southern (Sierra Leone)"},
%Cadastre.Subdivision{country_id: "SL", id: "W", name: "Western Area (Freetown)"}
]
iex> "SL" |> Cadastre.Country.new() |> Cadastre.Subdivision.all()
[
%Cadastre.Subdivision{country_id: "SL", id: "E", name: "Eastern"},
%Cadastre.Subdivision{country_id: "SL", id: "N", name: "Northern"},
%Cadastre.Subdivision{country_id: "SL", id: "S", name: "Southern (Sierra Leone)"},
%Cadastre.Subdivision{country_id: "SL", id: "W", name: "Western Area (Freetown)"}
]
iex> Cadastre.Subdivision.all("XX")
[]
iex> Cadastre.Subdivision.all(nil)
[]
Link to this function
ids(country_or_country_id)
View Sourceids(Cadastre.Country.t() | Cadastre.Country.id() | any()) :: [id()]
Returns all subdivision ids (ISO_3166-2) for country. Returns empty list for invalid argument.
Examples
iex> Cadastre.Subdivision.ids("SL")
["E", "N", "S", "W"]
iex> "SL" |> Cadastre.Country.new() |> Cadastre.Subdivision.ids()
["E", "N", "S", "W"]
iex> Cadastre.Subdivision.ids("XX")
[]
iex> Cadastre.Subdivision.ids(nil)
[]
Link to this function
name(subdivision, locale)
View Sourcename(t(), Cadastre.Language.id()) :: String.t()
Returns subdivision name translation for locale
Examples
iex> Cadastre.Subdivision.new("SL", "W") |> Cadastre.Subdivision.name("be")
"Заходняя вобласць"
iex> Cadastre.Subdivision.new("SL", "W") |> Cadastre.Subdivision.name(":)")
"Western Area (Freetown)"
iex> Cadastre.Subdivision.name("something wrong", "be")
nil
Link to this function
new(country_or_country_id, id)
View Sourcenew(Cadastre.Country.t() | Cadastre.Country.id() | any(), id() | any()) :: t() | nil
Returns %Cadastre.Subdivision{}
for valid country/country_id and id.
Returns nil
for invalid country/country_id and id.
Examples
iex> Cadastre.Subdivision.new("SL", "W")
%Cadastre.Subdivision{country_id: "SL", id: "W", name: "Western Area (Freetown)"}
iex> "SL" |> Cadastre.Country.new() |> Cadastre.Subdivision.new( "W")
%Cadastre.Subdivision{country_id: "SL", id: "W", name: "Western Area (Freetown)"}
iex> Cadastre.Subdivision.new("NL", "W")
nil
iex> Cadastre.Subdivision.new("SL", "X")
nil
iex> Cadastre.Subdivision.new(nil, nil)
nil