Module: Mongoid::Attributes::Readonly::ClassMethods

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Extended In: `::Mongoid::Attributes`, `::Mongoid::Composable`, `::Mongoid::Document`
Defined in:	lib/mongoid/attributes/readonly.rb

Instance Method Summary

#attr_readonly(*names)

Defines an attribute as readonly.

Instance Method Details

#attr_readonly(*names)

Defines an attribute as readonly. This will ensure that the value for the attribute is only set when the document is new or we are creating. In other cases, the field write will be ignored with the exception of #remove_attribute and #update_attribute, where an error will get raised.

Examples:

Flag fields as readonly.

class Band
  include Mongoid::Document
  field :name, type: String
  field :genre, type: String
  attr_readonly :name, :genre
end

Parameters:

*names (Symbol...) —

The names of the fields.

[ GitHub ]

# File 'lib/mongoid/attributes/readonly.rb', line 66


def attr_readonly(*names)
  names.each do |name|
    readonly_attributes << database_field_name(name)
  end
end