View Source Mobilizon.Cldr.DateTime (Mobilizon v4.1.0-alpha.1)
Summary
Functions
Formats a DateTime according to a format string as defined in CLDR and described in TR35
Arguments
datetime
is a%DateTime{}
or %NaiveDateTime{}
struct or any map that contains the keys:year
,:month
,:day
,:calendar
.:hour
,:minute
and:second
with optional:microsecond
.options
is a keyword list of options for formatting.
Options
format:
:short
|:medium
|:long
|:full
or a format string or any of the keys returned byCldr.DateTime.available_format_names
. 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 transliteratedera: :variant
will use a variant for the era is one is available in the locale. In the "en" for example, the localeera: :variant
will return "BCE" instead of "BC".period: :variant
will use a variant for the time period and flexible time period if one is available in the locale. For example, in the "en" localeperiod: :variant
will return "pm" instead of "PM"
Returns
{:ok, formatted_datetime}
or{:error, reason}
Examples
iex> {:ok, datetime} = DateTime.from_naive(~N[2000-01-01 23:59:59.0], "Etc/UTC")
iex> Mobilizon.Cldr.DateTime.to_string datetime
{:ok, "Jan 1, 2000, 11:59:59 PM"}
iex> Mobilizon.Cldr.DateTime.to_string datetime, locale: "en"
{:ok, "Jan 1, 2000, 11:59:59 PM"}
iex> Mobilizon.Cldr.DateTime.to_string datetime, format: :long, locale: "en"
{:ok, "January 1, 2000, 11:59:59 PM UTC"}
iex> Mobilizon.Cldr.DateTime.to_string datetime, format: :hms, locale: "en"
{:ok, "11:59:59 PM"}
iex> Mobilizon.Cldr.DateTime.to_string datetime, format: :full, locale: "en"
{:ok, "Saturday, January 1, 2000, 11:59:59 PM GMT"}
iex> Mobilizon.Cldr.DateTime.to_string datetime, format: :full, locale: "fr"
{:ok, "samedi 1 janvier 2000, 23:59:59 UTC"}
Formats a DateTime according to a format string as defined in CLDR and described in TR35 returning a formatted string or raising on error.
Arguments
datetime
is a%DateTime{}
or %NaiveDateTime{}
struct or any map that contains the keys:year
,:month
,:day
,:calendar
.:hour
,:minute
and:second
with optional:microsecond
.options
is a keyword list of options for formatting.
Options
format:
:short
|:medium
|:long
|:full
or a format string or any of the keys returned byCldr.DateTime.available_format_names
or a format string. The default is:medium
.:date_format
is any one of:short
,:medium
,:long
,:full
. If defined, this option is used to format the date part of the date time. This option is only acceptable if the:format
option is not specified, or is specified as either:short
,:medium
,:long
,:full
. If:date_format
is not specified then the date format is defined by the:format
option.:time_format
is any one of:short
,:medium
,:long
,:full
. If defined, this option is used to format the time part of the date time. This option is only acceptable if the:format
option is not specified, or is specified as either:short
,:medium
,:long
,:full
. If:time_format
is not specified then the time format is defined by the:format
option.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.era: :variant
will use a variant for the era is one is available in the locale. In the "en" for example, the localeera: :variant
will return "BCE" instead of "BC".period: :variant
will use a variant for the time period and flexible time period if one is available in the locale. For example, in the "en" localeperiod: :variant
will return "pm" instead of "PM".
Returns
formatted_datetime
orraises an exception
Examples
iex> {:ok, datetime} = DateTime.from_naive(~N[2000-01-01 23:59:59.0], "Etc/UTC")
iex> Mobilizon.Cldr.DateTime.to_string! datetime, locale: "en"
"Jan 1, 2000, 11:59:59 PM"
iex> Mobilizon.Cldr.DateTime.to_string! datetime, format: :long, locale: "en"
"January 1, 2000, 11:59:59 PM UTC"
iex> Mobilizon.Cldr.DateTime.to_string! datetime, format: :full, locale: "en"
"Saturday, January 1, 2000, 11:59:59 PM GMT"
iex> Mobilizon.Cldr.DateTime.to_string! datetime, format: :full, locale: "fr"
"samedi 1 janvier 2000, 23:59:59 UTC"