модуль ActionController::ParamsWrapper

Оборачивает хеш параметров в вложенный хеш. Это позволит клиентам отправлять запросы без необходимости указывать корневые элементы.

Эта функциональность включена в config/initializers/wrap_parameters.rb и может быть настроена.

Вы также можете включить её для конкретного контроллера, задав массив форматов непустым массивом:

class UsersController < ApplicationController
  wrap_parameters format: [:json, :xml, :url_encoded_form, :multipart_form]
end

Если вы включите ParamsWrapper для формата :json, вместо того, чтобы отправлять JSON-параметры так:

{"user": {"name": "Konata"}}

Вы можете отправлять параметры так:

{"name": "Konata"}

И они будут обернуты во вложенный хеш с именем ключа, соответствующим имени контроллера. Например, если вы отправляете POST-запрос на UsersController, ваш новый params хеш будет выглядеть так:

{"name" => "Konata", "user" => {"name" => "Konata"}}

Вы также можете указать ключ, в который следует обернуть параметры, а также список атрибутов, которые следует обернуть, используя :include или :exclude опции, например:

class UsersController < ApplicationController
  wrap_parameters :person, include: [:username, :password]
end

В моделях Active Record без заданных :include или :exclude опций, будут обернуты только параметры, возвращаемые методом класса attribute_names.

Если вы собираетесь передавать параметры объекту ActiveModel (например, User.new(params[:user])), вы можете рассмотреть возможность передачи класса модели в метод вместо этого. ParamsWrapper фактически попытается определить список имен атрибутов из модели и обернуть только эти атрибуты:

class UsersController < ApplicationController
  wrap_parameters Person
end

Вы всё ещё можете передать :include и :exclude, чтобы задать список атрибутов, которые вы хотите обернуть.

По умолчанию, если вы не укажете ключ, в который будут обернуты параметры, ParamsWrapper попытается определить, существует ли связанная модель или нет. Например, этот контроллер:

class Admin::UsersController < ApplicationController
end

попытается проверить, существуют ли модель Admin::User или User, и использовать её для определения ключа обертки соответственно. Если обе модели не существуют, он будет использовать user в качестве ключа.

Постоянные значения

EXCLUDE_PARAMETERS

Общедоступные методы экземпляра

process_action(*args) Показать исходный код

# File actionpack/lib/action_controller/metal/params_wrapper.rb, line 230
def process_action(*args)
  if _wrapper_enabled?
    if request.parameters[_wrapper_key].present?
      wrapped_hash = _extract_parameters(request.parameters)
    else
      wrapped_hash = _wrap_parameters request.request_parameters
    end

    wrapped_keys = request.request_parameters.keys
    wrapped_filtered_hash = _wrap_parameters request.filtered_parameters.slice(*wrapped_keys)

    # This will make the wrapped hash accessible from controller and view
    request.parameters.merge! wrapped_hash
    request.request_parameters.merge! wrapped_hash

    # This will display the wrapped hash in the log file
    request.filtered_parameters.merge! wrapped_filtered_hash
  end
  super
end

Выполняет обёртку параметров при запросе. Будет вызвана автоматически стеком вызовов мета-уровня.

Вызывает метод суперкласса