Document API for create's attributes parameter and provide examples. Closes #7915 [fearoffish]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@8296 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
This commit is contained in:
Marcel Molina
2007-12-05 17:33:18 +00:00
parent a7e6e009c9
commit a23bea7c0d
2 changed files with 13 additions and 2 deletions

View File

@@ -1,5 +1,7 @@
*SVN*
* Document API for create's attributes parameter and provide examples. Closes #7915 [fearoffish]
* Documentation for find incorrectly omits the :conditions option from various examples. Closes #7923 [mattwestcott]
* Document options and add examples for update. Closes #7985 [fearoffish]

View File

@@ -474,8 +474,17 @@ module ActiveRecord #:nodoc:
false
end
# Creates an object, instantly saves it as a record (if the validation permits it), and returns it. If the save
# fails under validations, the unsaved object is still returned.
# Creates an object (or multiple objects) and saves it to the database, if validations pass.
# The resulting object is returned whether the object was saved successfully to the database or not.
#
# The +attributes+ parameter can be either be a Hash or an Array of Hashes. These Hashes describe the
# attributes on the objects that are to be created.
#
# ==== Examples
# # Create a single new object
# User.create(:first_name => 'Jamie')
# # Create an Array of new objects
# User.create([{:first_name => 'Jamie'}, {:first_name => 'Jeremy'}])
def create(attributes = nil)
if attributes.is_a?(Array)
attributes.collect { |attr| create(attr) }