instance method `mattr_accessor`

Ruby on Rails 4.0.13

Since v2.2.3

Available in: v2.2.3 v2.3.18 v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

mattr_accessor(*syms)

Extends the module object with module and instance accessors for class attributes, just like the native attr* accessors for instance attributes.

module AppConfiguration
  mattr_accessor :google_api_key

  self.google_api_key = "123456789"
end

AppConfiguration.google_api_key # => "123456789"
AppConfiguration.google_api_key = "overriding the api key!"
AppConfiguration.google_api_key # => "overriding the api key!"

To opt out of the instance writer method, pass instance_writer: false. To opt out of the instance reader method, pass instance_reader: false. To opt out of both instance methods, pass instance_accessor: false.

Parameters

syms rest

Source

# File activesupport/lib/active_support/core_ext/module/attribute_accessors.rb, line 62
  def mattr_accessor(*syms)
    mattr_reader(*syms)
    mattr_writer(*syms)
  end

Defined in activesupport/lib/active_support/core_ext/module/attribute_accessors.rb line 62 · View on GitHub · Improve this page · Find usages on GitHub

Defined in Module

Signature

Parameters