Cldr.Time (Cldr Dates & Times v2.7.0) View Source
Provides localization and formatting of a Time
struct or any map with the keys :hour
, :minute
,
:second
and optionlly :microsecond
.
Cldr.Time
provides support for the built-in calendar
Calendar.ISO
or any calendars defined with
ex_cldr_calendars
CLDR provides standard format strings for Time
which
are reresented by the names :short
, :medium
, :long
and :full
. This allows for locale-independent
formatting since each locale may define the underlying
format string as appropriate.
Link to this section Summary
Link to this section Functions
Return the preferred time format for a locale.
Arguments
language_tag
is any language tag returned byCldr.Locale.new/2
or anylocale_name
returned byCldr.known_locale_names/1
Returns
- The hour format as an atom to be used for localization purposes. The
return value is used as a function name in
Cldr.DateTime.Formatter
Notes
The
hc
key of theu
extension is honoured and will override the default preferences for a locale or territory. See the last example below.Different locales and territories present the hour of day in different ways. These are represented in
Cldr.DateTime.Formatter
in the following way:
Symbol | Midn. | Morning | Noon | Afternoon | Midn. |
---|---|---|---|---|---|
h | 12 | 1...11 | 12 | 1...11 | 12 |
K | 0 | 1...11 | 0 | 1...11 | 0 |
H | 0 | 1...11 | 12 | 13...23 | 0 |
k | 24 | 1...11 | 12 | 13...23 | 24 |
Examples
iex> Cldr.Time.hour_format_from_locale "en-AU"
:hour_1_12
iex> Cldr.Time.hour_format_from_locale "fr"
:hour_0_23
iex> Cldr.Time.hour_format_from_locale "fr-u-hc-h12"
:hour_1_12
hour_format_from_locale(locale_name, backend \\ Cldr.Date.default_backend())
View Sourceto_string(time, backend \\ Cldr.Date.default_backend(), options \\ [])
View SourceSpecs
to_string(map(), Cldr.backend() | Keyword.t(), Keyword.t()) :: {:ok, String.t()} | {:error, {module(), String.t()}}
Formats a time according to a format string as defined in CLDR and described in TR35
Returns
{:ok, formatted_time}
or{:error, reason}
.
Arguments
time
is a%DateTime{}
or%NaiveDateTime{}
struct or any map that contains the keyshour
,minute
,second
and optionallycalendar
andmicrosecond
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:
any locale returned byCldr.known_locale_names/1
. The default isCldr.get_locale()
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" locale, for example,era: :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"
Examples
iex> Cldr.Time.to_string ~T[07:35:13.215217], MyApp.Cldr
{:ok, "7:35:13 AM"}
iex> Cldr.Time.to_string ~T[07:35:13.215217], MyApp.Cldr, format: :short
{:ok, "7:35 AM"}
iex> Cldr.Time.to_string ~T[07:35:13.215217], MyApp.Cldr, format: :medium, locale: "fr"
{:ok, "07:35:13"}
iex> Cldr.Time.to_string ~T[07:35:13.215217], MyApp.Cldr, format: :medium
{:ok, "7:35:13 AM"}
iex> {:ok, datetime} = DateTime.from_naive(~N[2000-01-01 23:59:59.0], "Etc/UTC")
iex> Cldr.Time.to_string datetime, MyApp.Cldr, format: :long
{:ok, "11:59:59 PM UTC"}
to_string!(time, backend \\ Cldr.Date.default_backend(), options \\ [])
View SourceSpecs
Formats a time according to a format string as defined in CLDR and described in TR35.
Arguments
time
is a%DateTime{}
or%NaiveDateTime{}
struct or any map that contains the keyshour
,minute
,second
and optionallycalendar
andmicrosecond
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 transliteratedera: :variant
will use a variant for the era is one is available in the locale. In the "en" locale, for example,era: :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_time_string
orraises an exception.
Examples
iex> Cldr.Time.to_string! ~T[07:35:13.215217], MyApp.Cldr
"7:35:13 AM"
iex> Cldr.Time.to_string! ~T[07:35:13.215217], MyApp.Cldr, format: :short
"7:35 AM"
iex> Cldr.Time.to_string ~T[07:35:13.215217], MyApp.Cldr, format: :short, period: :variant
{:ok, "7:35 AM"}
iex> Cldr.Time.to_string! ~T[07:35:13.215217], MyApp.Cldr, format: :medium, locale: "fr"
"07:35:13"
iex> Cldr.Time.to_string! ~T[07:35:13.215217], MyApp.Cldr, format: :medium
"7:35:13 AM"
iex> {:ok, datetime} = DateTime.from_naive(~N[2000-01-01 23:59:59.0], "Etc/UTC")
iex> Cldr.Time.to_string! datetime, MyApp.Cldr, format: :long
"11:59:59 PM UTC"