Module: ActiveAdmin::Filters::ResourceExtension
- Defined in:
- lib/active_admin/filters/resource_extension.rb
Instance Method Summary collapse
-
#add_filter(attribute, options = {}) ⇒ Object
Add a filter for this resource.
-
#filters ⇒ Hash
Returns the filters for this resource.
-
#filters=(bool) ⇒ Object
Setter to enable / disable filters on this resource.
-
#filters_enabled? ⇒ Boolean
If filters are enabled for this resource.
- #initialize ⇒ Object
- #preserve_default_filters! ⇒ Object
- #preserve_default_filters? ⇒ Boolean
-
#remove_filter(*attributes) ⇒ Object
Remove a filter for this resource.
-
#reset_filters! ⇒ Object
Reset the filters to use defaults.
Instance Method Details
#add_filter(attribute, options = {}) ⇒ Object
Add a filter for this resource. If filters are not enabled, this method will raise a RuntimeError
61 62 63 64 65 |
# File 'lib/active_admin/filters/resource_extension.rb', line 61 def add_filter(attribute, = {}) raise Disabled unless filters_enabled? (@filters ||= {})[attribute.to_sym] = end |
#filters ⇒ Hash
Returns the filters for this resource. If filters are not enabled, it will always return an empty array.
21 22 23 |
# File 'lib/active_admin/filters/resource_extension.rb', line 21 def filters filters_enabled? ? filter_lookup : {} end |
#filters=(bool) ⇒ Object
Setter to enable / disable filters on this resource.
Set to ‘nil` to inherit the setting from the namespace
28 29 30 |
# File 'lib/active_admin/filters/resource_extension.rb', line 28 def filters=(bool) @filters_enabled = bool end |
#filters_enabled? ⇒ Boolean
Returns If filters are enabled for this resource.
33 34 35 |
# File 'lib/active_admin/filters/resource_extension.rb', line 33 def filters_enabled? @filters_enabled.nil? ? namespace.filters : @filters_enabled end |
#initialize ⇒ Object
12 13 14 15 |
# File 'lib/active_admin/filters/resource_extension.rb', line 12 def initialize(*) super end |
#preserve_default_filters! ⇒ Object
37 38 39 |
# File 'lib/active_admin/filters/resource_extension.rb', line 37 def preserve_default_filters! @preserve_default_filters = true end |
#preserve_default_filters? ⇒ Boolean
41 42 43 |
# File 'lib/active_admin/filters/resource_extension.rb', line 41 def preserve_default_filters? @preserve_default_filters == true end |
#remove_filter(*attributes) ⇒ Object
Remove a filter for this resource. If filters are not enabled, this method will raise a RuntimeError
49 50 51 52 53 |
# File 'lib/active_admin/filters/resource_extension.rb', line 49 def remove_filter(*attributes) raise Disabled unless filters_enabled? attributes.each { |attribute| (@filters_to_remove ||= []) << attribute.to_sym } end |
#reset_filters! ⇒ Object
Reset the filters to use defaults
68 69 70 71 |
# File 'lib/active_admin/filters/resource_extension.rb', line 68 def reset_filters! @filters = nil @filters_to_remove = nil end |