Class: ActiveScaffold::Config::FieldSearch

Inherits:
Base show all
Defined in:
lib/active_scaffold/config/field_search.rb

Constant Summary collapse

NO_COLUMNS =
[].freeze
ActiveScaffold::DataStructures::ActionLink.new('show_search', :label => :search, :type => :collection, :security_method => :search_authorized?, :ignore_method => :field_search_ignore?)
@@text_search =
:full
@@human_conditions =
false

Constants inherited from Base

Base::NO_FORMATS

Instance Attribute Summary collapse

Attributes inherited from Base

#action_group, #core, #formats, #user_settings_key

Instance Method Summary collapse

Methods inherited from Base

#crud_type, inherited, #label, #model_id, #new_user_settings, #setup_user_setting_key, #user

Methods included from ActiveScaffold::Configurable

#configure, #method_missing, #respond_to_missing?

Constructor Details

#initialize(core_config) ⇒ FieldSearch

Returns a new instance of FieldSearch.


6
7
8
9
10
# File 'lib/active_scaffold/config/field_search.rb', line 6

def initialize(core_config)
  super
  @text_search = self.class.text_search
  @human_conditions = self.class.human_conditions
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ActiveScaffold::Configurable

Instance Attribute Details

#default_paramsObject

default search params default_params = => {“from”=>“test”, “to”=>“”, “opt”=>“%?%”}


68
69
70
# File 'lib/active_scaffold/config/field_search.rb', line 68

def default_params
  @default_params
end

#group_optionsObject

add array of columns as options for group by to get aggregated listings


61
62
63
# File 'lib/active_scaffold/config/field_search.rb', line 61

def group_options
  @group_options
end

#grouped_columnsObject

columns to display on aggregated listing


64
65
66
# File 'lib/active_scaffold/config/field_search.rb', line 64

def grouped_columns
  @grouped_columns
end

#human_conditionsObject

human conditions instead of just filtered you may show the user a humanized search condition statment


72
73
74
# File 'lib/active_scaffold/config/field_search.rb', line 72

def human_conditions
  @human_conditions
end

the ActionLink for this action


48
49
50
# File 'lib/active_scaffold/config/field_search.rb', line 48

def link
  @link
end

#text_searchObject

A flag for how the search should do full-text searching in the database:

  • :full: LIKE %?%

  • :start: LIKE ?%

  • :end: LIKE %?

  • false: LIKE ?

Default is :full


45
46
47
# File 'lib/active_scaffold/config/field_search.rb', line 45

def text_search
  @text_search
end

Instance Method Details

#optional_columnsObject


55
56
57
58
# File 'lib/active_scaffold/config/field_search.rb', line 55

def optional_columns
  return @optional_columns || NO_COLUMNS if frozen?
  @optional_columns ||= NO_COLUMNS.dup
end

#optional_columns=(optionals) ⇒ Object

rarely searched columns may be placed in a hidden subgroup


51
52
53
# File 'lib/active_scaffold/config/field_search.rb', line 51

def optional_columns=(optionals)
  @optional_columns = Array(optionals)
end