View Source Bonfire.Common.Localise.Cldr.DateTime (Bonfire v0.9.10-classic-beta.169)
Summary
Functions
@spec to_string(Cldr.Calendar.any_date_time(), Keyword.t()) :: {:ok, String.t()} | {:error, {module(), String.t()}}
Formats a DateTime according to a format string as defined in CLDR and described in TR35
Arguments
datetime
is aDateTime.t/0
or t:NaiveDateTime.t/0
struct or any map that contains one or more of the keys:year
,:month
,:day
,:hour
,:minute
and:second
or:microsecond
with optional:time_zone
,:zone_abbr
,:utc_offset
,:std_offset
and:calendar
fields.options
is a keyword list of options for formatting.
Options
:format
is one of:short
,:medium
,:long
,:full
or a format string or any of the keys in the map returned byCldr.DateTime.date_time_formats/3
. The default is:medium
. See here for more information about specifying formats.: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.:style
is either:at
or:default
. When set to:at
the datetime may be formatted with a localised string representing<date> at <time>
if such a format exists. SeeCldr.DateTime.Format.date_time_at_formats/2
.:prefer
is either:unicode
(the default) or:ascii
. A small number of formats have two variants - one using Unicode spaces (typically non-breaking space) and another using only ASCII whitespace. The:ascii
format is primarily to support legacy use cases and is not recommended. SeeCldr.DateTime.available_formats/3
to see which formats have these variants.:locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag.t/0
struct. The default isCldr.get_locale/0
.:number_system
a number system into which the formatted datetime digits should be transliterated.:era
which, if set to:variant
, will use a variant for the era if one is available in the requested locale. In the:en
locale, for example,era: :variant
will returnCE
instead ofAD
andBCE
instead ofBC
.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> Bonfire.Common.Localise.Cldr.DateTime.to_string datetime
{:ok, "Jan 1, 2000, 11:59:59 PM"}
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string datetime, locale: "en"
{:ok, "Jan 1, 2000, 11:59:59 PM"}
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string datetime, format: :long, locale: "en"
{:ok, "January 1, 2000, 11:59:59 PM UTC"}
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string datetime, format: :hms, locale: "en"
{:ok, "11:59:59 PM"}
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string datetime, format: :full, locale: "en"
{:ok, "Saturday, January 1, 2000, 11:59:59 PM GMT"}
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string datetime, format: :full, locale: "fr"
{:ok, "samedi 1 janvier 2000, 23:59:59 UTC"}
@spec to_string!(Cldr.Calendar.any_date_time(), Keyword.t()) :: String.t() | no_return()
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 aDateTime.t/0
or t:NaiveDateTime.t/0
struct or any map that contains one or more of the keys:year
,:month
,:day
,:hour
,:minute
and:second
or:microsecond
with optional:time_zone
,:zone_abbr
,:utc_offset
,:std_offset
and:calendar
fields.options
is a keyword list of options for formatting.
Options
:format
is one of:short
,:medium
,:long
,:full
or a format string or any of the keys in the map returned byCldr.DateTime.date_time_formats/3
. The default is:medium
. See here for more information about specifying formats.: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.:style
is either:at
or:default
. When set to:at
the datetime may be formatted with a localised string representing<date> at <time>
if such a format exists. SeeCldr.DateTime.Format.date_time_at_formats/2
.:prefer
is either:unicode
(the default) or:ascii
. A small number of formats have two variants - one using Unicode spaces (typically non-breaking space) and another using only ASCII whitespace. The:ascii
format is primarily to support legacy use cases and is not recommended. SeeCldr.DateTime.available_formats/3
to see which formats have these variants.:locale
is any valid locale name returned byCldr.known_locale_names/0
or aCldr.LanguageTag.t/0
struct. The default isCldr.get_locale/0
.:number_system
a number system into which the formatted datetime digits should be transliterated.:era
which, if set to:variant
, will use a variant for the era if one is available in the requested locale. In the:en
locale, for example,era: :variant
will returnCE
instead ofAD
andBCE
instead ofBC
.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, date_time} = DateTime.from_naive(~N[2000-01-01 23:59:59.0], "Etc/UTC")
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string!(date_time, locale: :en)
"Jan 1, 2000, 11:59:59 PM"
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string!(date_time, format: :long, locale: :en)
"January 1, 2000, 11:59:59 PM UTC"
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string!(date_time, format: :full, locale: :en)
"Saturday, January 1, 2000, 11:59:59 PM GMT"
iex> Bonfire.Common.Localise.Cldr.DateTime.to_string!(date_time, format: :full, locale: :fr)
"samedi 1 janvier 2000, 23:59:59 UTC"