Cldr Dates & Times

v1.2.0

Cldr Dates & Times

Cldr Dates & Times v1.2.0 Cldr.Calendar View Source

Calendar support functions for formatting dates, times and datetimes.

Cldr defines formats for several calendars, the names of which are returned by Cldr.Calendar.known_calendars/0.

Currently this implementation only supports the :gregorian calendar which aligns with the proleptic Gregorian calendar defined by Elixir, Calendar.ISO.

This module will be extacted in the future to become part of a separate calendrical module.

Link to this section Summary

Functions

add(date, n)

Returns the date n days after the provided data

calendars()

Returns the calendar type and calendar era definitions for the calendars in CLDR

date_from_iso_days(days, calendar)

Returns a date struct for a given iso days

day_key(int)
day_of_week(map)

Returns the day of the week for a date where the first day is Monday and the result is in the range 1 (for Monday) to 7 (for Sunday)

day_of_year(date)

Returns the ordinal day of the year for a given date

day_ordinal(arg1)
default_calendar()

Returns the default CLDR calendar name

era_from_iso_days(iso_days, calendar)

Returns the era number for a given rata die

era_number_from_date(date, calendar \\ Cldr.Calendar.default_calendar())

Returns the era number for a given date and calendar

first_day_of_month(date)

Returns the first day of the month

first_day_of_week(locale)

Returns the first day of a week for a locale as an ordinal number in then range one to seven with one representing Monday and seven representing Sunday

iso_days_from_date(date)

Returns iso days for a given date

iso_days_from_datetime(arg1)

Converts a datetime to iso days

known_calendars()
minumim_days_in_week_one(territory \\ :US)

Returns the minimum days required in a week for it to be considered week one of a year

naive_datetime_from_date(map)

Converts a date to a naive datetime

next_day(date)

Returns the date of the next day to the provided date

nth_week_of_year(date, n)

Returns the date that is the first day of the nth week of the year that containts the supplied date

nth_week_of_year(year, n, arg)
previous_day(date)

Returns the date of the previous day to the provided date

sub(date, n)

Returns the date n days after the provided data

week_info()

Returns the CLDR data that defines the structure of a week in different locales

year(date)

Returns a Date.Rage with the first date as the first day of the year and the last day as the last day of the year

Link to this section Functions

Link to this function add(date, n) View Source

Returns the date n days after the provided data.

Examples

Link to this function calendars() View Source

Returns the calendar type and calendar era definitions for the calendars in CLDR.

Example 

Cldr.Calendar.calendars
%{buddhist: %{calendar_system: "solar", eras: [{0, %{start: -198326}}]},
  chinese: %{calendar_system: "lunisolar", eras: [{0, %{start: -963144}}]},
  coptic: %{calendar_system: "other",
    eras: [{0, %{end: 103604}}, {1, %{start: 103605}}]},
  dangi: %{calendar_system: "lunisolar", eras: [{0, %{start: -852110}}]},
  ethiopic: %{calendar_system: "other",
    eras: [{0, %{end: 2797}}, {1, %{start: 2798}}]},
  ethiopic_amete_alem: %{eras: [{0, %{end: -2006036}}]},
  gregorian: %{calendar_system: "solar",
    eras: [{0, %{end: 0}}, {1, %{start: 1}}]}, ...
Link to this function date_from_iso_days(days, calendar) View Source

Returns a date struct for a given iso days

Link to this function day_of_week(map) View Source 
day_of_week(Date.t()) :: 1..7

Returns the day of the week for a date where the first day is Monday and the result is in the range 1 (for Monday) to 7 (for Sunday)

  • date is a Date or any other struct that contains the keys :year, :month, ;day and :calendar

Examples 

iex> Cldr.Calendar.day_of_week ~D[2017-09-03]
7

iex> Cldr.Calendar.day_of_week ~D[2017-09-01]
5
Link to this function day_of_year(date) View Source 
day_of_year(Date.t()) :: 1..366

Returns the ordinal day of the year for a given date.

  • date is a Date or any other struct that contains the keys :year, :month, ;day and :calendar

Example 

iex> Cldr.Calendar.day_of_year ~D[2017-01-01]
1

iex> Cldr.Calendar.day_of_year ~D[2017-09-03]
246

iex> Cldr.Calendar.day_of_year ~D[2017-12-31]
365
Link to this function default_calendar() View Source

Returns the default CLDR calendar name.

Note this is not the same as the default calendar Calendar.ISO supported by Elixir.

Example 

iex> Cldr.Calendar.default_calendar
:gregorian
Link to this function era_from_iso_days(iso_days, calendar) View Source

Returns the era number for a given rata die.

The era number is an index into Cldr list of eras for a given calendar which is primarily for the use of Cldr.Date.to_string/2 when processing the format symbol G. For further information see Cldr.DateTime.Formatter.era/4.

Link to this function era_number_from_date(date, calendar \\ Cldr.Calendar.default_calendar()) View Source

Returns the era number for a given date and calendar

Example 

iex> Cldr.Calendar.era_number_from_date ~D[2017-09-03], :gregorian
1

iex> Cldr.Calendar.era_number_from_date ~D[0000-09-03], :gregorian
0

iex> Cldr.Calendar.era_number_from_date ~D[1700-09-03], :japanese
208
Link to this function first_day_of_month(date) View Source

Returns the first day of the month.

Note that whilst this is trivial for an ISO/Gregorian calendar it may well be quite different for other types of calendars

Link to this function first_day_of_week(locale) View Source

Returns the first day of a week for a locale as an ordinal number in then range one to seven with one representing Monday and seven representing Sunday.

Example 

iex> Cldr.Calendar.first_day_of_week "en"
7

iex> Cldr.Calendar.first_day_of_week "en-GB"
1
Link to this function iso_days_from_date(date) View Source

Returns iso days for a given date

Link to this function iso_days_from_datetime(arg1) View Source

Converts a datetime to iso days

Link to this function minumim_days_in_week_one(territory \\ :US) View Source

Returns the minimum days required in a week for it to be considered week one of a year.

Examples 

iex> Cldr.Calendar.minumim_days_in_week_one :US
1

iex> Cldr.Calendar.minumim_days_in_week_one :FR
4
Link to this function naive_datetime_from_date(map) View Source

Converts a date to a naive datetime

Link to this function next_day(date) View Source

Returns the date of the next day to the provided date.

Examples 

iex> Cldr.Calendar.next_day %{calendar: Calendar.ISO, day: 2, month: 1, year: 2017}
%{calendar: Calendar.ISO, day: 3, month: 1, year: 2017}

iex> Cldr.Calendar.next_day %{calendar: Calendar.ISO, day: 28, month: 2, year: 2017}
%{calendar: Calendar.ISO, day: 1, month: 3, year: 2017}

iex> Cldr.Calendar.next_day %{calendar: Calendar.ISO, day: 28, month: 2, year: 2016}
%{calendar: Calendar.ISO, day: 29, month: 2, year: 2016}
Link to this function nth_week_of_year(date, n) View Source

Returns the date that is the first day of the nth week of the year that containts the supplied date.

  • date is a Date or any other struct that contains the keys :year, :month, ;day and :calendar

  • n is the week number

NOTE The first week is defined according to the week definition of the ISO Week calendar.

Example 

iex> Cldr.Calendar.nth_week_of_year ~D[2017-01-04], 1
%{calendar: Calendar.ISO, day: 2, month: 1, year: 2017}
Link to this function nth_week_of_year(year, n, arg) View Source
Link to this function previous_day(date) View Source

Returns the date of the previous day to the provided date.

Example 

iex> Cldr.Calendar.previous_day %{calendar: Calendar.ISO, day: 2, month: 1, year: 2017}
%{calendar: Calendar.ISO, day: 1, month: 1, year: 2017}

iex> Cldr.Calendar.previous_day %{calendar: Calendar.ISO, day: 1, month: 3, year: 2017}
%{calendar: Calendar.ISO, day: 28, month: 2, year: 2017}

iex> Cldr.Calendar.previous_day %{calendar: Calendar.ISO, day: 1, month: 3, year: 2016}
%{calendar: Calendar.ISO, day: 29, month: 2, year: 2016}
Link to this function sub(date, n) View Source

Returns the date n days after the provided data.

Example 

iex> Cldr.Calendar.add %{calendar: Calendar.ISO, day: 1, month: 3, year: 2017}, 3
%{calendar: Calendar.ISO, day: 4, month: 3, year: 2017}
Link to this function week_info() View Source

Returns the CLDR data that defines the structure of a week in different locales.

Example 

Cldr.Calendar.week_info
%{first_day: %{IN: "sun", SM: "mon", MN: "mon", MZ: "sun", CR: "mon", AT: "mon",
    LA: "sun", EE: "mon", NL: "mon", PT: "mon", PH: "sun", BG: "mon", LT: "mon",
    ES: "mon", OM: "sat", SY: "sat", US: "sun", EC: "mon", SG: "sun", DM: "sun",
    AR: "sun", MK: "mon", YE: "sun", KW: "sat", GB: "mon",
    "GB-alt-variant": "sun", AD: "mon", UZ: "mon", KG: "mon", CZ: "mon",
    FI: "mon", RO: "mon", TR: "mon", AI: "mon", MM: "sun", AS: "sun", BS: "sun",
    IT: "mon", MX: "sun", BR: "sun", ID: "sun", NZ: "sun", GP: "mon", BE: "mon",
    CO: "sun", GR: "mon", NP: "sun", ME: "mon", MO: "sun", ...},
  min_days: %{SM: 4, SJ: 4, AT: 4, EE: 4, NL: 4, PT: 4, BG: 4, LT: 4, ES: 4,
    US: 1, GI: 4, GB: 4, AD: 4, CZ: 4, FI: 4, IT: 4, GP: 4, JE: 4, BE: 4, GR: 4,
    "001": 1, VI: 1, RE: 4, SE: 4, GU: 1, IS: 4, AN: 4, IM: 4, GG: 4, CH: 4,
    FO: 4, UM: 1, SK: 4, AX: 4, LU: 4, FR: 4, IE: 4, HU: 4, FJ: 4, MC: 4, GF: 4,
    NO: 4, DK: 4, DE: 4, LI: 4, PL: 4, VA: 4, MQ: 4}, weekend_end: nil,
  weekend_start: nil}
Link to this function year(date) View Source

Returns a Date.Rage with the first date as the first day of the year and the last day as the last day of the year

Example