Skip to content
Browse files

Docfix (closes #10369) [revans]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@8428 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
1 parent dcc1549 commit be0c45365c912240b4979150f8c1284916007bca @dhh dhh committed Dec 17, 2007
Showing with 17 additions and 1 deletion.
  1. +17 −1 activesupport/lib/active_support/core_ext/date_time/conversions.rb
View
18 activesupport/lib/active_support/core_ext/date_time/conversions.rb
@@ -15,7 +15,22 @@ def self.included(base)
remove_method :to_time if base.instance_methods.include?(:to_time)
end
end
-
+
+ # Convert to a formatted string - see DATE_FORMATS for predefined formats.
+ # You can also add your own formats to the DATE_FORMATS constant and use them with this method.
+ #
+ # This method is also aliased as <tt>to_s</tt>.
+ #
+ # === 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"
def to_formatted_s(format = :default)
if formatter = ::Time::DATE_FORMATS[format]
if formatter.respond_to?(:call)
@@ -49,6 +64,7 @@ def to_datetime
self
end
+ # Converts datetime to an appropriate format for use in XML
def xmlschema
strftime("%Y-%m-%dT%H:%M:%S%Z")
end if RUBY_VERSION < '1.9'

0 comments on commit be0c453

Please sign in to comment.
Something went wrong with that request. Please try again.