Permalink
Browse files

expanded comment for update_attribute method

  • Loading branch information...
1 parent efdfcf1 commit 5c137939a7b9d32a46eb07c90d6b535c7c67db64 Neeraj Singh committed with fxn Jul 20, 2010
Showing with 9 additions and 2 deletions.
  1. +9 −2 activerecord/lib/active_record/persistence.rb
View
11 activerecord/lib/active_record/persistence.rb
@@ -102,8 +102,15 @@ def becomes(klass)
became
end
- # Updates a single attribute and saves the record without going through the normal validation procedure
- # or callbacks. This is especially useful for boolean flags on existing records.
+ # Updates a single attribute and saves the record.
+ # This is especially useful for boolean flags on existing records. Also note that
+ #
+ # * validation is skipped
+ # * No callbacks are invoked
+ # * updated_at/updated_on column is updated if that column is available
+ # * does not work on associations
+ # * does not work on attr_accessor attributes. The attribute that is being updated must be column name.
+ #
def update_attribute(name, value)
raise ActiveRecordError, "#{name.to_s} is marked as readonly" if self.class.readonly_attributes.include? name.to_s

0 comments on commit 5c13793

Please sign in to comment.