Module: ActionController::ParamsWrapper::ClassMethods

Defined in:
actionpack/lib/action_controller/metal/params_wrapper.rb

Instance Method Summary collapse

Instance Method Details

#inherited(klass) ⇒ Object

Sets the default wrapper key or model which will be used to determine wrapper key and attribute names. Will be called automatically when the module is inherited.



131
132
133
134
135
136
 
# File 'actionpack/lib/action_controller/metal/params_wrapper.rb', line 131

def inherited(klass)
  if klass._wrapper_options[:format].present?
    klass._set_wrapper_defaults(klass._wrapper_options.slice(:format))
  end
  super
end

#wrap_parameters(name_or_model_or_options, options = {}) ⇒ Object

Sets the name of the wrapper key, or the model which ParamsWrapper would use to determine the attribute names from.

Examples

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.

Options

  • :format - The list of formats in which the parameters wrapper will be enabled.

  • :include - The list of attribute names which parameters wrapper will wrap into a nested hash.

  • :exclude - The list of attribute names which parameters wrapper will exclude from a nested hash.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'actionpack/lib/action_controller/metal/params_wrapper.rb', line 111

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

  _set_wrapper_defaults(_wrapper_options.slice(:format).merge(options), model)
end