Class: DrgcmsFormFields::Select

Inherits:
DrgcmsField show all
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'
    
  • 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

Direct Known Subclasses

TextWithSelect, TreeSelect

Instance Attribute Summary

Attributes inherited from DrgcmsField

#js

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DrgcmsField

#hash_to_options, #html, #initialize, #record_text_for, #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.



151
152
153
154
155
156
157
158
159
160
161
# File 'app/models/drgcms_form_fields/select.rb', line 151

def self.get_data(params, name)
  if params['record'][name].class == Array
    params['record'][name].delete_if {|e| e.blank? }
    return nil 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
    return params['record'][name]
  end
  params['record'][name]
end

Instance Method Details

#do_eval(e) ⇒ Object

Return values, when choices options will be returned by evaluating expression



65
66
67
68
69
70
71
72
# File 'app/models/drgcms_form_fields/select.rb', line 65

def do_eval(e)
  e.strip!
  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
  eval e
end

#get_choicesObject

Create choices array for select field.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'app/models/drgcms_form_fields/select.rb', line 77

def get_choices
  begin
    choices = case 
    when @yaml['choices'] then 
      (@yaml['choices'].match('helpers.') ) ? t(@yaml['choices']) : @yaml['choices']
    when @yaml['eval']    then
      do_eval(@yaml['eval'])
    else 
      c = t('helpers.label.' + @form['table'] + '.choices4_' + @yaml['name'] )
      c = 'Error' if c.match( 'translation missing' )
      c
    end
  # Convert string to Array
    choices.class == String ?
      choices.chomp.split(',').inject([]) {|r,v| r << (v.match(':') ? v.split(':') : v )} :
      choices
  rescue Exception => e 
    Rails.logger.debug "Error in select eval. #{e.message}\n"
    ['error'] # return empty array when error occures
  end
end

#renderObject

Render select field html code



133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'app/models/drgcms_form_fields/select.rb', line 133

def render
  return ro_standard if @readonly
  set_initial_value('html','selected')
#
  @yaml['html'].symbolize_keys!
  record = record_text_for(@yaml['name'])
  if @yaml['multiple']  
    @html << @parent.select(record, @yaml['name'], get_choices, @yaml['html'], {multiple: true})
    @js   << "$('##{record}_#{@yaml['name']}').selectMultiple();"
  else
    @html << @parent.select(record, @yaml['name'], get_choices, @yaml['html'])
  end
  self
end

#ro_standardObject

Return value when readonly is required



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'app/models/drgcms_form_fields/select.rb', line 102

def ro_standard
  value = @record.respond_to?(@yaml['name']) ? @record[@yaml['name']] : nil
  return self if value.nil?
# 
  choices = get_choices()
  if value.class == Array   # multiple choices
    html = ''
    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
    return super(html)
  else
    choices.each do |choice|
      if choice.class == Array
        return super(choice.first) if choice.last.to_s == value.to_s
      else
        return super(choice) if choice.to_s == value.to_s
      end 
    end
  end
  super('')
end