модуль ActionController::ParamsWrapper::Options::ClassMethods

Публичные методы экземпляра

_set_wrapper_options(options) Показать исходный код

# File actionpack/lib/action_controller/metal/params_wrapper.rb, line 180
def _set_wrapper_options(options)
  self._wrapper_options = Options.from_hash(options)
end

inherited(klass) Показать исходный код

# File actionpack/lib/action_controller/metal/params_wrapper.rb, line 235
def inherited(klass)
  if klass._wrapper_options.format.any?
    params = klass._wrapper_options.dup
    params.klass = klass
    klass._wrapper_options = params
  end
  super
end

Устанавливает значение по умолчанию для ключа обёртки или модели, которые будут использоваться для определения ключей обёртки и имён атрибутов. Вызывается автоматически при наследовании модуля.

Вызывает метод родительского класса

wrap_parameters(name_or_model_or_options, options = {}) Показать исходный код

# File actionpack/lib/action_controller/metal/params_wrapper.rb, line 211
def wrap_parameters(name_or_model_or_options, options = {})
  model = nil

  case name_or_model_or_options
  when Hash
    options = name_or_model_or_options
  when false
    options = options.merge(format: [])
  when Symbol, String
    options = options.merge(name: name_or_model_or_options)
  else
    model = name_or_model_or_options
  end

  opts = Options.from_hash _wrapper_options.to_h.slice(:format).merge(options)
  opts.model = model
  opts.klass = self

  self._wrapper_options = opts
end

Устанавливает имя ключа обёртки или модель, которая ParamsWrapper будет использоваться для определения имён атрибутов.

Примеры

wrap_parameters format: :xml
  # enables the parameter wrapper for XML format

wrap_parameters :person
  # wraps parameters into +params[:person]+ hash

wrap_parameters Person
  # wraps parameters by determining the wrapper key from Person class
  # (+person+, in this case) and the list of attribute names

wrap_parameters include: [:username, :title]
  # wraps only +:username+ and +:title+ attributes from parameters.

wrap_parameters false
  # disables parameters wrapping for this controller altogether.

:format — список форматов, в которых будет активирована обёртка параметров.
:include — список имён атрибутов, которые обёртка параметров будет упаковывать в вложенный массив.
:exclude — список имён атрибутов, которые обёртка параметров будет исключать из вложенного массива.