Class | DateTime
In: | lib/standard/facets/date.rb
Parent: | Object

### Methods

advance ago beginning_of_day change end_of_day future? getutc in local_offset midnight past? seconds_since_midnight since stamp to_date to_datetime to_f to_time utc utc? utc_offset xmlschema

### Public Class methods

local_offset()

### Public Instance methods

advance(options)

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`.

ago(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!

beginning_of_day()

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

change(options)

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.

end_of_day()

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

future?()
getutc()

Alias for utc

in(seconds)

Alias for since

midnight()

Alias for beginning_of_day

past?()
seconds_since_midnight()

Seconds since midnight: DateTime.now.seconds_since_midnight

since(seconds)

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!

stamp(format=:default)

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

This method is aliased to `to_s`.

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

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

## Adding your own datetime formats to stamp

DateTime formats are shared with Time. You can add your own to the Time::FORMAT hash. Use the format name as the hash key and a strftime string as the value. Eg.

      Time::FORMAT[:month_and_year] = "%B %Y"

to_date()

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

to_datetime()

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

to_f()

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

to_time()

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.

utc()

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

utc?()

Returns true if offset == 0

utc_offset()

Returns the offset value in seconds

xmlschema()

Converts datetime to an appropriate format for use in XML

[Validate]