View Source Cldr.Date (Cldr Dates & Times v2.16.0)
Provides localization and formatting of a Date
struct or any map with the keys :year
, :month
,
:day
and :calendar
.
Cldr.Date
provides support for the built-in calendar
Calendar.ISO
or any calendars defined with
ex_cldr_calendars
CLDR provides standard format strings for Date
which
are reresented by the styles :short
, :medium
, :long
and :full
. This allows for locale-independent
formatting since each locale may define the underlying
format string as appropriate.
Summary
Functions
to_string(date, backend \\ Cldr.Date.default_backend(), options \\ [])
View Source@spec to_string(map(), Cldr.backend() | Keyword.t(), Keyword.t()) :: {:ok, String.t()} | {:error, {module(), String.t()}}
Formats a date according to a format string as defined in CLDR and described in TR35
Arguments
date
is a%Date{}
struct or any map that contains the keysyear
,month
,day
andcalendar
backend
is any module that includesuse Cldr
and therefore is aCldr
backend module. The default isCldr.default_backend/0
.options
is a keyword list of options for formatting. The valid options are:
Options
:format
is on of:short
,:medium
,:long
,:full
or a format string. The default is:medium
.locale:
any locale returned byCldr.known_locale_names/1
. The default isCldr.get_locale/0
.:number_system
a number system into which the formatted date digits should be transliterated.
Returns
{:ok, formatted_string}
or{:error, reason}
Examples
iex> Cldr.Date.to_string ~D[2017-07-10], MyApp.Cldr, format: :medium, locale: "en"
{:ok, "Jul 10, 2017"}
iex> Cldr.Date.to_string ~D[2017-07-10], MyApp.Cldr, locale: "en"
{:ok, "Jul 10, 2017"}
iex> Cldr.Date.to_string ~D[2017-07-10], MyApp.Cldr, format: :full, locale: "en"
{:ok, "Monday, July 10, 2017"}
iex> Cldr.Date.to_string ~D[2017-07-10], MyApp.Cldr, format: :short, locale: "en"
{:ok, "7/10/17"}
iex> Cldr.Date.to_string ~D[2017-07-10], MyApp.Cldr, format: :short, locale: "fr"
{:ok, "10/07/2017"}
iex> Cldr.Date.to_string ~D[2017-07-10], MyApp.Cldr, style: :long, locale: "af"
{:ok, "10 Julie 2017"}
to_string!(date, backend \\ Cldr.Date.default_backend(), options \\ [])
View SourceFormats a date according to a format string as defined in CLDR and described in TR35
Arguments
date
is a%Date{}
struct or any map that contains the keysyear
,month
,day
andcalendar
backend
is any module that includesuse Cldr
and therefore is aCldr
backend module. The default isCldr.default_backend!/0
.options
is a keyword list of options for formatting.
Options
format:
:short
|:medium
|:long
|:full
or a format string. The default is:medium
locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag
struct. The default isCldr.get_locale/0
number_system:
a number system into which the formatted date digits should be transliterated
Returns
formatted_date
orraises an exception.
Examples
iex> Cldr.Date.to_string! ~D[2017-07-10], MyApp.Cldr, format: :medium, locale: "en"
"Jul 10, 2017"
iex> Cldr.Date.to_string! ~D[2017-07-10], MyApp.Cldr, locale: "en"
"Jul 10, 2017"
iex> Cldr.Date.to_string! ~D[2017-07-10], MyApp.Cldr, format: :full,locale: "en"
"Monday, July 10, 2017"
iex> Cldr.Date.to_string! ~D[2017-07-10], MyApp.Cldr, format: :short, locale: "en"
"7/10/17"
iex> Cldr.Date.to_string! ~D[2017-07-10], MyApp.Cldr, format: :short, locale: "fr"
"10/07/2017"
iex> Cldr.Date.to_string! ~D[2017-07-10], MyApp.Cldr, format: :long, locale: "af"
"10 Julie 2017"