Class: DrgcmsFormFields::Select
- Inherits:
-
DrgcmsField
- Object
- DrgcmsField
- DrgcmsFormFields::Select
- Defined in:
- app/models/drgcms_form_fields/select.rb
Overview
Implementation of select DRG CMS form field.
Form options:
-
name:
field name (required) -
type:
select (required) -
choices:
Values for choices separated by comma. Values can also be specified like description:value.
In the example description will be shown to user, but value will be saved to document.
choices: 'OK:0,Ready:1,Error:2'
choices: Ruby,Pyton,PHP
-
eval:
Choices will be provided by evaluating expression-
eval: dc_choices4(‘model_name’,‘description_field_name’,‘_id’); dc_choices4 helper will provide data for select field.
-
eval: ModelName.choices4_field; ModelName class will define method choices4_field which
will provide data for select field.
-
collection_name.search_field_name.method_name; When searching is more complex custom search
method may be defined in CollectionName model which will provide result set for search.
-
-
If choices or eval is not defined choices will be provided from translation helpers. For example: Collection has field status choices for field may be provided by en.helpers.model_name.choices4_status entry of english translation. English is of course default translation. If you provide translations in your local language then select choices will be localized.
en.helpers.model_name.choices4_status: 'OK:0,Ready:1,Error:2' sl.helpers.model_name.choices4_status: 'V redu:0,Pripravljen:1,Napaka:2'
-
depend:
Select options may depend on a value in some other field. If depend option is specified then chices must be provided by class method and defined in eval option. -
html:
html options which apply to select field (optional)
Form example:
30:
name: type
type: select
40:
name: parent
type: select
eval: DcCategory.values_for_parent
html:
include_blank: true
50:
name: company
type: select
choices: Audi,BMW,Mercedes
or
choices: helpers.label.model.choices4_field
60:
name: type
type: select
eval: Cars.choices4_type
depend: company
Direct Known Subclasses
Instance Attribute Summary
Attributes inherited from DrgcmsField
Class Method Summary collapse
-
.get_data(params, name) ⇒ Object
Return value.
Instance Method Summary collapse
-
#add_view_code ⇒ Object
Will add code to view more data about selected option in a window.
-
#choices_in_eval(e) ⇒ Object
Choices are defined by evaluating an expression.
-
#choices_in_helper(helper = nil) ⇒ Object
Choices are defined in helper as: helper.label.table_name.choices_for_fieldname or choices4_tablename_fieldname.
-
#get_choices ⇒ Object
Create choices array for select field.
-
#render ⇒ Object
Render select field html code.
-
#ro_standard ⇒ Object
Return value when readonly is required.
Methods inherited from DrgcmsField
#__css_code, #hash_to_options, #html, #initialize, #record_text_for, #set_css_code, #set_default_value, #set_initial_value, #set_style, #t
Constructor Details
This class inherits a constructor from DrgcmsFormFields::DrgcmsField
Class Method Details
.get_data(params, name) ⇒ Object
Return value.
212 213 214 215 216 217 218 219 220 221 222 |
# File 'app/models/drgcms_form_fields/select.rb', line 212 def self.get_data(params, name) if params['record'][name].class == Array params['record'][name].delete_if {|e| e.blank? } return if params['record'][name].size == 0 # convert to BSON objects is_id = BSON::ObjectId.legal?(params['record'][name].first) return params['record'][name].map{ |e| BSON::ObjectId.from_string(e) } if is_id end params['record'][name] end |
Instance Method Details
#add_view_code ⇒ Object
Will add code to view more data about selected option in a window
144 145 146 147 148 149 150 151 |
# File 'app/models/drgcms_form_fields/select.rb', line 144 def add_view_code return '' if (data = @record.send(@yaml['name'])).blank? table, form_name = @yaml['view'].split(/\ |\,/).delete_if { |e| e.blank? } url = @parent.url_for(controller: 'cmsedit', id: data, action: :edit, table: table, form_name: form_name, readonly: true, window_close: 1 ) icon = @parent.fa_icon('eye') %(<span class="dc-window-open" data-url="#{url}">#{icon}</span>) end |
#choices_in_eval(e) ⇒ Object
Choices are defined by evaluating an expression. This is most common class method defined in a class. eg. SomeClass.get_choices4
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'app/models/drgcms_form_fields/select.rb', line 94 def choices_in_eval(e) e.strip! if @yaml['depend'].nil? method = e.split(/\ |\(/).first return eval(e) if respond_to?(method) # id method defined here return eval('@parent.' + e) if @parent.respond_to?(method) # is method defined in helpers # eval whatever it is there eval e else # add event listener to depend field @js << %( $(document).ready(function() { $('#record_#{@yaml['depend']}').change( function(e) { update_select_depend('record_#{@yaml['name']}', 'record_#{@yaml['depend']}','#{e}');}); $('#_record_#{@yaml['depend']}').change( function(e) { update_select_depend('record_#{@yaml['name']}', '_record_#{@yaml['depend']}','#{e}');}); }); ) # depend field might be virtual field. It's value should be set in params depend_value = @yaml['depend'][0] == '_' ? @parent.params["p_#{@yaml['depend']}"] : @record[@yaml['depend']] e << " '#{depend_value}'" eval e end end |
#choices_in_helper(helper = nil) ⇒ Object
Choices are defined in helper as: helper.label.table_name.choices_for_fieldname or choices4_tablename_fieldname
80 81 82 83 84 85 86 87 88 |
# File 'app/models/drgcms_form_fields/select.rb', line 80 def choices_in_helper(helper = nil) helper ||= "helpers.label.#{@form['table']}.choices4_#{@yaml['name']}" c = t(helper) if c.match( 'translation missing' ) helper = "choices_for_#{@form['table']}_#{@yaml['name']}" return "Error. #{helper} not defined" if c.match( 'translation missing' ) end c end |
#get_choices ⇒ Object
Create choices array for select field.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'app/models/drgcms_form_fields/select.rb', line 121 def get_choices begin choices = case when @yaml['eval'] then choices_in_eval(@yaml['eval']) when @yaml['choices'] then @yaml['choices'].match('helpers.') ? choices_in_helper(@yaml['choices']) : @yaml['choices'] else choices_in_helper() end return choices unless choices.class == String choices.chomp.split(',').map { |e| e.match(':') ? e.split(':') : e } rescue Exception => e Rails.logger.debug "\nError in select eval. #{e.}\n" Rails.logger.debug(e.backtrace.join($/)) if Rails.env.development? ['error'] # return empty array when error occures end end |
#render ⇒ Object
Render select field html code
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'app/models/drgcms_form_fields/select.rb', line 187 def render return ro_standard if @readonly set_initial_value('html','selected') # separate options and html part = {} @yaml['html'].symbolize_keys! %i(selected include_blank).each { |sym| [sym] = @yaml['html'].delete(sym) if @yaml['html'][sym] } @yaml['html'][:multiple] = true if @yaml['multiple'] record = record_text_for(@yaml['name']) if @yaml['html'][:multiple] @html << @parent.select(record, @yaml['name'], get_choices, , @yaml['html']) @js << "$('##{record}_#{@yaml['name']}').selectMultiple();" else @html << @parent.select(record, @yaml['name'], get_choices, , @yaml['html']) # add code for view more data @html << add_view_code() if @yaml['view'] end self end |
#ro_standard ⇒ Object
Return value when readonly is required
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'app/models/drgcms_form_fields/select.rb', line 156 def ro_standard value = @record.respond_to?(@yaml['name']) ? @record.send(@yaml['name']) : nil return self if value.blank? html = '' choices = get_choices() if value.class == Array # multiple choices value.each do |element| choices.each do |choice| if choice.to_s == element.to_s html << '<br>' if html.size > 0 html << "#{element.to_s}" end end end else choices.each do |choice| if choice.class == Array (html = choice.first; break) if choice.last.to_s == value.to_s else (html = choice; break) if choice.to_s == value.to_s end end html << add_view_code if @yaml['view'] end super(html) end |