Class DateTime
In: lib/active_support/json/encoding.rb
lib/active_support/core_ext/date_time/zones.rb
lib/active_support/core_ext/date_time/calculations.rb
lib/active_support/core_ext/date_time/acts_like.rb
lib/active_support/core_ext/date_time/conversions.rb
Parent: Object

Methods

External Aliases

<=> -> compare_without_coercion
to_s -> to_default_s
inspect -> default_inspect

Public Class methods

DateTimes aren‘t aware of DST rules, so use a consistent non-DST offset when creating a DateTime with an offset in the local zone

Public Instance methods

<=>(other)

Duck-types as a Date-like class. See Object#acts_like?.

Duck-types as a Time-like class. See Object#acts_like?.

Uses Date to provide precise Time calculations for years, months, and days. The options parameter takes a hash with any of these keys: :years, :months, :weeks, :days, :hours, :minutes, :seconds.

Returns a new DateTime representing the time a number of seconds ago Do not use this method in combination with x.months, use months_ago instead!

at_beginning_of_day()

Alias for beginning_of_day

at_midnight()

Alias for beginning_of_day

Returns a new DateTime representing the start of the day (0:00)

Returns a new DateTime where one or more of the elements have been changed according to the options parameter. The time options (hour, minute, sec) reset cascadingly, so if only the hour is passed, then minute and sec is set to 0. If the hour and minute is passed, then sec is set to 0.

Layers additional behavior on DateTime#<=> so that Time and ActiveSupport::TimeWithZone instances can be compared with a DateTime

Returns a new DateTime representing the end of the day (23:59:59)

Returns the utc_offset as an +HH:MM formatted string. Examples:

  datetime = DateTime.civil(2000, 1, 1, 0, 0, 0, Rational(-6, 24))
  datetime.formatted_offset         # => "-06:00"
  datetime.formatted_offset(false)  # => "-0600"

Tells whether the DateTime object‘s datetime lies in the future

getutc()

Alias for utc

in(seconds)

Alias for since

Returns the simultaneous time in Time.zone.

  Time.zone = 'Hawaii'             # => 'Hawaii'
  DateTime.new(2000).in_time_zone  # => Fri, 31 Dec 1999 14:00:00 HST -10:00

This method is similar to Time#localtime, except that it uses Time.zone as the local zone instead of the operating system‘s time zone.

You can also pass in a TimeZone instance or string that identifies a TimeZone as an argument, and the conversion will be based on that zone instead of Time.zone.

  DateTime.new(2000).in_time_zone('Alaska')  # => Fri, 31 Dec 1999 15:00:00 AKST -09:00
inspect()

Alias for readable_inspect

midnight()

Alias for beginning_of_day

Tells whether the DateTime object‘s datetime lies in the past

Overrides the default inspect method with a human readable one, e.g., "Mon, 21 Feb 2005 14:30:00 +0000"

Returns a new DateTime representing the time a number of seconds since the instance time Do not use this method in combination with x.months, use months_since instead!

Converts self to a Ruby Date object; time portion is discarded

To be able to keep Times, Dates and DateTimes interchangeable on conversions

Converts self to a floating-point number of seconds since the Unix epoch

Convert to a formatted string. See Time::DATE_FORMATS for predefined formats.

This method is aliased to to_s.

Examples

  datetime = DateTime.civil(2007, 12, 4, 0, 0, 0, 0)   # => Tue, 04 Dec 2007 00:00:00 +0000

  datetime.to_formatted_s(:db)            # => "2007-12-04 00:00:00"
  datetime.to_s(:db)                      # => "2007-12-04 00:00:00"
  datetime.to_s(:number)                  # => "20071204000000"
  datetime.to_formatted_s(:short)         # => "04 Dec 00:00"
  datetime.to_formatted_s(:long)          # => "December 04, 2007 00:00"
  datetime.to_formatted_s(:long_ordinal)  # => "December 4th, 2007 00:00"
  datetime.to_formatted_s(:rfc822)        # => "Tue, 04 Dec 2007 00:00:00 +0000"

Adding your own datetime formats to to_formatted_s

DateTime formats are shared with Time. You can add your own to the Time::DATE_FORMATS hash. Use the format name as the hash key and either a strftime string or Proc instance that takes a time or datetime argument as the value.

  # config/initializers/time_formats.rb
  Time::DATE_FORMATS[:month_and_year] = "%B %Y"
  Time::DATE_FORMATS[:short_ordinal] = lambda { |time| time.strftime("%B #{time.day.ordinalize}") }

Converts self to an integer number of seconds since the Unix epoch

to_s(format = :default)

Alias for to_formatted_s

Attempts to convert self to a Ruby Time object; returns self if out of range of Ruby Time class If self has an offset other than 0, self will just be returned unaltered, since there‘s no clean way to map it to a Time

Adjusts DateTime to UTC by adding its offset value; offset is set to 0

Example:

  DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24))       # => Mon, 21 Feb 2005 10:11:12 -0600
  DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24)).utc   # => Mon, 21 Feb 2005 16:11:12 +0000

Returns true if offset == 0

Returns the offset value in seconds

Converts datetime to an appropriate format for use in XML

[Validate]