提交 a4eaecc8 编写于 作者: M Matthew Stopa

Add more documentation to TimeWithZone

[ci skip]
上级 dfc930b2
...@@ -109,6 +109,14 @@ def utc_offset ...@@ -109,6 +109,14 @@ def utc_offset
alias_method :gmt_offset, :utc_offset alias_method :gmt_offset, :utc_offset
alias_method :gmtoff, :utc_offset alias_method :gmtoff, :utc_offset
# Returns a formatted string of the offset from UTC, or an alternative
# string if the time zone is already UTC.
#
# Time.zone = 'Eastern Time (US & Canada)' # => "Eastern Time (US & Canada)"
# Time.zone.now.formatted_offset(true) # => "-05:00"
# Time.zone.now.formatted_offset(false) # => "-0500"
# Time.zone = 'UTC' # => "UTC"
# Time.zone.now.formatted_offset(true, "0") # => "0"
def formatted_offset(colon = true, alternate_utc_string = nil) def formatted_offset(colon = true, alternate_utc_string = nil)
utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon) utc? && alternate_utc_string || TimeZone.seconds_to_utc_offset(utc_offset, colon)
end end
...@@ -206,18 +214,24 @@ def <=>(other) ...@@ -206,18 +214,24 @@ def <=>(other)
utc <=> other utc <=> other
end end
# Returns true if the current object's time is within the specified
# +min+ and +max+ time.
def between?(min, max) def between?(min, max)
utc.between?(min, max) utc.between?(min, max)
end end
# Returns true if the current object's time is in the past.
def past? def past?
utc.past? utc.past?
end end
# Returns true if the current object's time falls within
# the current day.
def today? def today?
time.today? time.today?
end end
# Returns true if the current object's time is in the future.
def future? def future?
utc.future? utc.future?
end end
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册