- Inheritance
Converting datetimes to formatted strings, dates, and times.
Methods
Instance
| Visibility | Signature |
|---|---|
| public | formatted_offset (colon = true, alternate_utc_string = nil) |
| public | readable_inspect () |
| public | to_date () |
| public | to_datetime () |
| public | to_f () |
| public | to_formatted_s (format = :default) |
| public | to_time () |
| public | xmlschema () |
Instance Method Detail
formatted_offset(colon = true, alternate_utc_string = nil)
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"
readable_inspect()
Overrides the default inspect method with a human readable one, e.g., "Mon, 21 Feb 2005 14:30:00 +0000"
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_formatted_s(format = :default)
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}") }
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
xmlschema()
Converts datetime to an appropriate format for use in XML