class ParameterFilter
Ruby on Rails 7.2.3
Since v6.0.6Active Support Parameter Filter
ParameterFilter replaces values in a Hash-like object if their keys match one of the specified filters.
Matching based on nested keys is possible by using dot notation, e.g. "credit_card.number".
If a proc is given as a filter, each key and value of the Hash-like and of any nested Hashes will be passed to it. The value or key can then be mutated as desired using methods such as String#replace.
# Replaces values with "[FILTERED]" for keys that match /password/i. ActiveSupport::ParameterFilter.new([:password]) # Replaces values with "[FILTERED]" for keys that match /foo|bar/i. ActiveSupport::ParameterFilter.new([:foo, "bar"]) # Replaces values for the exact key "pin" and for keys that begin with # "pin_". Does not match keys that otherwise include "pin" as a # substring, such as "shipping_id". ActiveSupport::ParameterFilter.new([/\Apin\z/, /\Apin_/]) # Replaces the value for :code in `{ credit_card: { code: "xxxx" } }`. # Does not change `{ file: { code: "xxxx" } }`. ActiveSupport::ParameterFilter.new(["credit_card.code"]) # Reverses values for keys that match /secret/i. ActiveSupport::ParameterFilter.new([-> (k, v) do v.reverse! if /secret/i.match?(k) end])
Inherits from
Constants
Methods (defined here)
- # filter
- # filter_param
- self. new
- self. precompile_filters
Private methods
(3)
Implementation detail — not part of the public API.
Methods (inherited)
From Object (17)
- # acts_like?
- # blank?
- # deep_dup
- # duplicable?
- # html_safe?
- # in?
- # instance_values
- # instance_variable_names
- # presence
- # presence_in
- # present?
- # to_param
- # to_query
- # try
- # try!
- # with
- # with_options
From ActiveSupport::NumericWithFormat (2)
- # to_formatted_s
- # to_fs