跳至内容 跳至搜索
方法
#
A
B
C
D
E
F
G
I
L
M
N
R
S
T
U
包含的模块

类公有方法

civil_from_format(utc_or_local, year, month = 1, day = 1, hour = 0, min = 0, sec = 0)

返回 DateTime,如果格式是本地时间,则具有给定年份的本地偏移量,否则偏移量为零。

DateTime.civil_from_format :local, 2012
# => Sun, 01 Jan 2012 00:00:00 +0300
DateTime.civil_from_format :local, 2012, 12, 17
# => Mon, 17 Dec 2012 00:00:00 +0000
# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 69
def self.civil_from_format(utc_or_local, year, month = 1, day = 1, hour = 0, min = 0, sec = 0)
  if utc_or_local.to_sym == :local
    offset = ::Time.local(year, month, day).utc_offset.to_r / 86400
  else
    offset = 0
  end
  civil(year, month, day, hour, min, sec, offset)
end

current()

Time.zoneconfig.time_zone设置时,返回Time.zone.now.to_datetime,否则返回Time.now.to_datetime

# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 10
def current
  ::Time.zone ? ::Time.zone.now.to_datetime : ::Time.now.to_datetime
end

实例公有方法

<=>(other)

DateTime#<=> 上添加额外行为,以便可以比较 TimeActiveSupport::TimeWithZone 实例与 DateTime

# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 208
def <=>(other)
  if other.respond_to? :to_datetime
    super other.to_datetime rescue nil
  else
    super
  end
end

acts_like_date?()

作为 Date 类鸭子类型。参见 Object#acts_like?

# File activesupport/lib/active_support/core_ext/date_time/acts_like.rb, line 8
def acts_like_date?
  true
end

acts_like_time?()

作为 Time 类鸭子类型。参见 Object#acts_like?

# File activesupport/lib/active_support/core_ext/date_time/acts_like.rb, line 13
def acts_like_time?
  true
end

advance(options)

使用 Date 为年份、月份和日期提供精确的 Time 计算。options 参数接受一个包含以下任何键的哈希值::years:months:weeks:days:hours:minutes:seconds

就像 Date#advance 一样,增量按时间单位从大到小应用。这种顺序可能会影响月底的结果。

# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 82
def advance(options)
  unless options[:weeks].nil?
    options[:weeks], partial_weeks = options[:weeks].divmod(1)
    options[:days] = options.fetch(:days, 0) + 7 * partial_weeks
  end

  unless options[:days].nil?
    options[:days], partial_days = options[:days].divmod(1)
    options[:hours] = options.fetch(:hours, 0) + 24 * partial_days
  end

  d = to_date.advance(options)
  datetime_advanced_by_date = change(year: d.year, month: d.month, day: d.day)
  seconds_to_advance = \
    options.fetch(:seconds, 0) +
    options.fetch(:minutes, 0) * 60 +
    options.fetch(:hours, 0) * 3600

  if seconds_to_advance.zero?
    datetime_advanced_by_date
  else
    datetime_advanced_by_date.since(seconds_to_advance)
  end
end

ago(seconds)

返回一个新的 DateTime,表示几秒钟之前的时间。不要将此方法与 x.months 结合使用,而应使用 months_ago!

# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 109
def ago(seconds)
  since(-seconds)
end

at_beginning_of_day()

at_beginning_of_hour()

at_beginning_of_minute()

at_end_of_day()

别名: end_of_day

at_end_of_hour()

别名: end_of_hour

at_end_of_minute()

别名: end_of_minute

at_midday()

别名: middle_of_day

at_middle_of_day()

别名: middle_of_day

at_midnight()

at_noon()

别名: middle_of_day

beginning_of_day()

返回一个新的 DateTime,表示一天的开始 (0:00)。

# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 122
def beginning_of_day
  change(hour: 0)
end

beginning_of_hour()

返回一个新的 DateTime,表示小时的开始 (hh:00:00)。

# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 146
def beginning_of_hour
  change(min: 0)
end

beginning_of_minute()

返回一个新的 DateTime,表示分钟的开始 (hh:mm:00)。

# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 158
def beginning_of_minute
  change(sec: 0)
end

change(options)

返回一个新的 DateTime,其中一个或多个元素已根据options参数更改。时间选项 (:hour:min:sec) 按级联方式重置,因此如果只传递小时,则分钟和秒将设置为 0。如果传递小时和分钟,则秒将设置为 0。options 参数接受一个包含以下任何键的哈希值::year:month:day:hour:min:sec:offset:start

DateTime.new(2012, 8, 29, 22, 35, 0).change(day: 1)              # => DateTime.new(2012, 8, 1, 22, 35, 0)
DateTime.new(2012, 8, 29, 22, 35, 0).change(year: 1981, day: 1)  # => DateTime.new(1981, 8, 1, 22, 35, 0)
DateTime.new(2012, 8, 29, 22, 35, 0).change(year: 1981, hour: 0) # => DateTime.new(1981, 8, 29, 0, 0, 0)
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 51
def change(options)
  if new_nsec = options[:nsec]
    raise ArgumentError, "Can't change both :nsec and :usec at the same time: #{options.inspect}" if options[:usec]
    new_fraction = Rational(new_nsec, 1000000000)
  else
    new_usec = options.fetch(:usec, (options[:hour] || options[:min] || options[:sec]) ? 0 : Rational(nsec, 1000))
    new_fraction = Rational(new_usec, 1000000)
  end

  raise ArgumentError, "argument out of range" if new_fraction >= 1

  ::DateTime.civil(
    options.fetch(:year, year),
    options.fetch(:month, month),
    options.fetch(:day, day),
    options.fetch(:hour, hour),
    options.fetch(:min, options[:hour] ? 0 : min),
    options.fetch(:sec, (options[:hour] || options[:min]) ? 0 : sec) + new_fraction,
    options.fetch(:offset, offset),
    options.fetch(:start, start)
  )
end

default_inspect()

别名: inspect

end_of_day()

返回一个新的 DateTime,表示一天的结束 (23:59:59)。

也称为: at_end_of_day
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 140
def end_of_day
  change(hour: 23, min: 59, sec: 59, usec: Rational(999999999, 1000))
end

end_of_hour()

返回一个新的 DateTime,表示小时的结束 (hh:59:59)。

也称为: at_end_of_hour
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 152
def end_of_hour
  change(min: 59, sec: 59, usec: Rational(999999999, 1000))
end

end_of_minute()

返回一个新的 DateTime,表示分钟的结束 (hh:mm:59)。

也称为: at_end_of_minute
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 164
def end_of_minute
  change(sec: 59, usec: Rational(999999999, 1000))
end

formatted_offset(colon = true, alternate_utc_string = nil)

返回一个格式化的字符串,表示相对于 UTC 的偏移量,或者如果时区已经是 UTC,则返回一个备用字符串。

datetime = DateTime.civil(2000, 1, 1, 0, 0, 0, Rational(-6, 24))
datetime.formatted_offset         # => "-06:00"
datetime.formatted_offset(false)  # => "-0600"
# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 51
def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || ActiveSupport::TimeZone.seconds_to_utc_offset(utc_offset, colon)
end

getgm()

别名:utc

getlocal(utc_offset = nil)

别名:localtime

getutc()

别名:utc

gmtime()

别名:utc

in(seconds)

别名:since

inspect()

也作为别名:default_inspect

localtime(utc_offset = nil)

返回一个Time实例,表示系统时区中的同时时间。

也作为别名:getlocal
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 170
def localtime(utc_offset = nil)
  utc = new_offset(0)

  Time.utc(
    utc.year, utc.month, utc.day,
    utc.hour, utc.min, utc.sec + utc.sec_fraction
  ).getlocal(utc_offset)
end

midday()

别名: middle_of_day

middle_of_day()

返回一个新的DateTime,表示一天的中午 (12:00)

# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 130
def middle_of_day
  change(hour: 12)
end

midnight()

noon()

别名: middle_of_day

nsec()

返回以纳秒为单位的小数秒部分。

# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 94
def nsec
  (sec_fraction * 1_000_000_000).to_i
end

readable_inspect()

使用人类可读的格式覆盖默认的 inspect 方法,例如,“Mon, 21 Feb 2005 14:30:00 +0000”。

也作为别名:inspect
# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 56
def readable_inspect
  to_fs(:rfc822)
end

seconds_since_midnight()

返回从 00:00:00 开始的秒数。

DateTime.new(2012, 8, 29,  0,  0,  0).seconds_since_midnight # => 0
DateTime.new(2012, 8, 29, 12, 34, 56).seconds_since_midnight # => 45296
DateTime.new(2012, 8, 29, 23, 59, 59).seconds_since_midnight # => 86399
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 20
def seconds_since_midnight
  sec + (min * 60) + (hour * 3600)
end

seconds_until_end_of_day()

返回到 23:59:59 的秒数。

DateTime.new(2012, 8, 29,  0,  0,  0).seconds_until_end_of_day # => 86399
DateTime.new(2012, 8, 29, 12, 34, 56).seconds_until_end_of_day # => 41103
DateTime.new(2012, 8, 29, 23, 59, 59).seconds_until_end_of_day # => 0
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 29
def seconds_until_end_of_day
  end_of_day.to_i - to_i
end

since(seconds)

返回一个新的DateTime,表示自实例时间以来经过的秒数。不要将此方法与 x.months 结合使用,请改用 months_since!

也作为别名:in
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 116
def since(seconds)
  self + Rational(seconds, 86400)
end

subsec()

返回小数秒部分,表示为Rational

DateTime.new(2012, 8, 29, 0, 0, 0.5).subsec # => (1/2)
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 36
def subsec
  sec_fraction
end

to_f()

self转换为自 Unix 纪元以来的秒数浮点数,包括小数微秒。

# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 79
def to_f
  seconds_since_unix_epoch.to_f + sec_fraction
end

to_formatted_s(format = :default)

别名:to_fs

to_fs(format = :default)

转换为格式化的字符串。请参阅 Time::DATE_FORMATS 以获取预定义的格式。

此方法的别名为to_formatted_s

示例

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

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

将自己的日期时间格式添加到 to_fs

DateTime格式与Time共享。您可以将自己的格式添加到 Time::DATE_FORMATS 哈希中。使用格式名称作为哈希键,并将 strftime 字符串或接受时间或日期时间参数的 Proc 实例作为值。

# 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}") }
也作为别名:to_formatted_s
# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 35
def to_fs(format = :default)
  if formatter = ::Time::DATE_FORMATS[format]
    formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
  else
    to_s
  end
end

to_i()

self转换为自 Unix 纪元以来的秒数整数。

# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 84
def to_i
  seconds_since_unix_epoch.to_i
end

to_time()

返回一个Time实例,其 UTC 偏移量与self相同,或者返回一个Time实例,其表示本地系统时区中的相同时间,具体取决于ActiveSupport.to_time_preserves_timezone的设置。

# File activesupport/lib/active_support/core_ext/date_time/compatibility.rb, line 15
def to_time
  preserve_timezone ? getlocal(utc_offset) : getlocal
end

usec()

返回以微秒为单位的小数秒部分。

# File activesupport/lib/active_support/core_ext/date_time/conversions.rb, line 89
def usec
  (sec_fraction * 1_000_000).to_i
end

utc()

返回一个Time实例,表示 UTC 时区中的同时时间。

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 UTC
也作为别名:getgm, getutc, gmtime
# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 184
def utc
  utc = new_offset(0)

  Time.utc(
    utc.year, utc.month, utc.day,
    utc.hour, utc.min, utc.sec + utc.sec_fraction
  )
end

utc?()

如果offset == 0,则返回true

# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 197
def utc?
  offset == 0
end

utc_offset()

返回以秒为单位的偏移量值。

# File activesupport/lib/active_support/core_ext/date_time/calculations.rb, line 202
def utc_offset
  (offset * 86400).to_i
end