View Source Cldr.DateTime (Cldr Dates & Times v2.17.0)

Provides localization and formatting of a DateTime struct or any map with the keys :year, :month, :day, :calendar, :hour, :minute, :second and optionally :microsecond.

Cldr.DateTime provides support for the built-in calendar Calendar.ISO or any calendars defined with ex_cldr_calendars

CLDR provides standard format strings for DateTime which are reresented by the names :short, :medium, :long and :full. This allows for locale-independent formatting since each locale will define the underlying format string as appropriate.

Summary

Functions

to_string(datetime, backend \\ Cldr.Date.default_backend(), options \\ [])

Formats a DateTime according to a format string as defined in CLDR and described in TR35

to_string!(datetime, backend \\ Cldr.Date.default_backend(), options \\ [])

Formats a DateTime according to a format string as defined in CLDR and described in TR35 returning a formatted string or raising on error.

Functions

to_string(datetime, backend \\ Cldr.Date.default_backend(), options \\ [])

@spec to_string(map(), Cldr.backend() | Keyword.t(), 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 a %DateTime{} or %NaiveDateTime{}struct or any map that contains the keys :year, :month, :day, :calendar. :hour, :minute and :second with optional :microsecond.
backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend/0.
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 returned by Cldr.DateTime.Format.date_time_available_formats/0. 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.
:style is either :at or :default. When set to :at the datetime is formatted with a localised string representing <date> at <time>. See Cldr.DateTime.Format.date_time_at_formats/2.
:prefer is either :unicode (the default) or :ascii. A small number of datetime 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. See Cldr.DateTime.Format.date_time_available_formats/1 to see which formats have these variants.
:locale is any valid locale name returned by Cldr.known_locale_names/0 or a Cldr.LanguageTag struct. The default is Cldr.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 locale 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" locale period: :variant will return "pm" instead of "PM".

Returns

{:ok, formatted_datetime} or
{:error, reason}

Examples

iex> {:ok, date_time} = DateTime.from_naive(~N[2000-01-01 23:59:59.0], "Etc/UTC")
iex> Cldr.DateTime.to_string(date_time)
{:ok, "Jan 1, 2000, 11:59:59 PM"}
iex> Cldr.DateTime.to_string(date_time, MyApp.Cldr, locale: :en)
{:ok, "Jan 1, 2000, 11:59:59 PM"}
iex> Cldr.DateTime.to_string(date_time, MyApp.Cldr, format: :long, locale: :en)
{:ok, "January 1, 2000, 11:59:59 PM UTC"}
iex> Cldr.DateTime.to_string(date_time, MyApp.Cldr, format: :hms, locale: :en)
{:ok, "11:59:59 PM"}
iex> Cldr.DateTime.to_string(date_time, MyApp.Cldr, format: :full, locale: :en)
{:ok, "Saturday, January 1, 2000, 11:59:59 PM GMT"}
iex> Cldr.DateTime.to_string(date_time, MyApp.Cldr, format: :full, locale: :fr)
{:ok, "samedi 1 janvier 2000, 23:59:59 UTC"}
iex> Cldr.DateTime.to_string(date_time, MyApp.Cldr, format: :full, style: :at, locale: :en)
{:ok, "Saturday, January 1, 2000 at 11:59:59 PM GMT"}
iex> Cldr.DateTime.to_string(date_time, MyApp.Cldr, format: :full, style: :at, locale: :fr)
{:ok, "samedi 1 janvier 2000 à 23:59:59 UTC"}
iex> Cldr.DateTime.to_string(date_time, MyApp.Cldr, format: :MMMMW, locale: :fr)
{:ok, "semaine 1 (janvier)"}
iex> Cldr.DateTime.to_string(date_time, MyApp.Cldr, format: :yw, locale: :fr)
{:ok, "semaine 1 de 2000"}