Class: DrgcmsFormFields::DrgcmsField
- Inherits:
-
Object
- Object
- DrgcmsFormFields::DrgcmsField
- Defined in:
- app/models/drgcms_form_fields/drgcms_field.rb
Overview
Template method for DRG CMS form field definition. This is abstract class with most of the common code for custom form field already implemented.
Direct Known Subclasses
Action, CheckBox, Comment, DatePicker, DateSelect, DatetimePicker, DatetimeSelect, Embedded, FileField, FileSelect, HashField, HiddenField, HtmlField, JournalDiff, LinkTo, Method, MultitextAutocomplete, NumberField, PasswordField, Readonly, Select, SubmitTag, TextArea, TextAutocomplete, TextField
Instance Attribute Summary collapse
-
#css ⇒ Object
readonly
Returns the value of attribute css.
-
#js ⇒ Object
readonly
Returns the value of attribute js.
Class Method Summary collapse
-
.get_data(params, name) ⇒ Object
Default get_data method for retrieving data from parameters.
Instance Method Summary collapse
-
#hash_to_options(options) ⇒ Object
Will return ruby hash formated as javascript string which can be used for passing parameters in javascript code.
-
#html ⇒ Object
Returns html code together with CSS code.
-
#initialize(parent, record, yaml) ⇒ DrgcmsField
constructor
DrgcmsField initialization code.
-
#options_to_hash(options) ⇒ Object
Options may be defined on form as hash or as string.
-
#record_text_for(name) ⇒ Object
Checks if field name exists in document and alters record parameters if necesary.
-
#ro_standard(value = nil) ⇒ Object
Standard code for returning readonly field.
-
#set_css_code(css) ⇒ Object
Sets css code for the field if specified.
-
#set_default_value(opt1, opt2) ⇒ Object
Will set default value.
-
#set_initial_value(opt1 = 'html', opt2 = 'value') ⇒ Object
Set initial value of the field when initial value is set in url parameters..
-
#set_style ⇒ Object
Returns style html code for DRGForm object if style directive is present in field definition.
-
#t(key, default = '') ⇒ Object
Wrapper for i18 t method, with some spice added.
Constructor Details
#initialize(parent, record, yaml) ⇒ DrgcmsField
DrgcmsField initialization code.
Parameters:
- parent
-
Controller object. Controller object from where object is created. Usually self is send.
- record
-
Document object. Document object which holds fields data.
- yaml
-
Hash. Hash object holding field definition data.
Returns: Self
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 78 def initialize( parent, record, yaml ) @parent = parent @record = record @yaml = yaml @form = parent.form @yaml['html'] ||= {} # set readonly field @readonly = (@yaml and @yaml['readonly']) || (@form and @form['readonly']) @yaml['html']['readonly'] = true if @readonly # assign size to html element if not already there @yaml['html']['size'] ||= @yaml['size'] if @yaml['size'] @html = '' @js = '' @css = set_css_code @yaml['css'] self end |
Instance Attribute Details
#css ⇒ Object (readonly)
Returns the value of attribute css.
65 66 67 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 65 def css @css end |
#js ⇒ Object (readonly)
Returns the value of attribute js.
64 65 66 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 64 def js @js end |
Class Method Details
.get_data(params, name) ⇒ Object
Default get_data method for retrieving data from parameters. Class method is called for every entry field defined on form before field value is saved to database.
Parameters:
- params
-
Controllers params object.
- name
-
Field name
Most of classes will use this default method which returns params[name]. When field data is more complex class should implement its own get_data method.
314 315 316 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 314 def self.get_data(params, name) params['record'][name] end |
Instance Method Details
#hash_to_options(options) ⇒ Object
Will return ruby hash formated as javascript string which can be used for passing parameters in javascript code.
Parameters:
- Hash
-
Hash. Ruby hash parameters.
Form example: As used in forms
options:
height: 400
width: 800
toolbar: "basic"
=> "height:400, width:800, toolbar: 'basic'"
Return: String: Options formated as javascript options.
244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 244 def () c = '' .each do |key, option| c << "#{key} : " c << case when option.to_s.match(/function/i) then option when option.class == String then "\"#{option}\"" else option.to_s end c << ",\n" end c end |
#html ⇒ Object
Returns html code together with CSS code.
99 100 101 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 99 def html @html end |
#options_to_hash(options) ⇒ Object
Options may be defined on form as hash or as string. This method will ensure conversion of options into hash.
Parameters:
- String or Hash
-
: Form options
Form example: As used in forms
options:
height: 400
width: 800
toolbar: "'basic'"
or
options: "height:400, width:800, toolbar:'basic'"
Return: Hash: Options as Hash
277 278 279 280 281 282 283 284 285 286 287 288 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 277 def () return {} if .nil? return unless .class == String .chomp.split(',').inject({}) do |r, e| key, value = e.chomp.split(':') value.strip! value = value[1..value.size - 2] if value[0] =~ /\'|\"/ r[key.strip] = value r end end |
#record_text_for(name) ⇒ Object
Checks if field name exists in document and alters record parameters if necesary. Method was added after fields that do not belong to current edited document were added to forms. Valid nonexisting form field names must start with underscore (_) letter.
Return: String: ‘record’ or ‘_record’ when valid nonexisting field is used
298 299 300 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 298 def record_text_for(name) (!@record.respond_to?(name) and name[0,1] == '_') ? '_record' : 'record' end |
#ro_standard(value = nil) ⇒ Object
Standard code for returning readonly field.
130 131 132 133 134 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 130 def ro_standard(value = nil) value ||= @yaml['html']['value'] || (@record.respond_to?(@yaml['name']) ? @record.send(@yaml['name']) : nil) @html << %(<div id="#{@yaml['name']}" class="dc-readonly">#{value}</div>) self end |
#set_css_code(css) ⇒ Object
Sets css code for the field if specified. It replaces all occurences of ‘# ’ with field name id, as defined on form.
218 219 220 221 222 223 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 218 def set_css_code(css) return '' if css.blank? css.gsub!('# ',"#td_record_#{@yaml['name']} ") if css.match('# ') css end |
#set_default_value(opt1, opt2) ⇒ Object
Will set default value
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 163 def set_default_value(opt1, opt2) return if @yaml[opt1][opt2].present? return if @record && @record[@yaml['name']].present? @yaml[opt1][opt2] = if @yaml['default'].class == Hash evaluate = @yaml['default']['eval'] return if evaluate.blank? # add @parent if it's a method call and @parent is not present if evaluate[0] != evaluate[0].upcase && !evaluate.match('@parent') evaluate.prepend('@parent.') end eval(evaluate) else @yaml['default'] end end |
#set_initial_value(opt1 = 'html', opt2 = 'value') ⇒ Object
Set initial value of the field when initial value is set in url parameters..
Example: Form has field named picture. Field can be initialized by setting value of param p_picture.
params['p_picture'] = '/path/to_picture'
When multiple initial values are assigned it is more convinient to assign them through flash object.
flash[:record] = {}
flash[:record]['picture'] = '/path/to_picture'
148 149 150 151 152 153 154 155 156 157 158 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 148 def set_initial_value(opt1 = 'html', opt2 = 'value') @yaml['html'] ||= {} value_send_as = 'p_' + @yaml['name'] if @parent.params[value_send_as] @yaml[opt1][opt2] = @parent.params[value_send_as] elsif @parent.flash[:record] value = @parent.flash[:record][@yaml['name']] || @parent.flash[:record][@yaml['name'].to_sym] @yaml[opt1][opt2] = value if value end set_default_value(opt1, opt2) if @yaml['default'] end |
#set_style ⇒ Object
Returns style html code for DRGForm object if style directive is present in field definition. Otherwise returns empty string.
Style may be defined like:
style:
height: 400px
width: 800px
padding: 10px 20px
or
style: "height:400px; width:800px; padding: 10px 20px;"
Style directive may also be defined under html directive.
html:
style:
height: 400px
width: 800px
202 203 204 205 206 207 208 209 210 211 212 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 202 def set_style() style = @yaml['html']['style'] || @yaml['style'] case when style.nil? then '' when style.class == String then "style=\"#{style}\"" when style.class == Hash then value = style.to_a.inject([]) {|r,v| r << "#{v[0]}: #{v[1]}" }.join(';') "style=\"#{value}\"" else '' end end |
#t(key, default = '') ⇒ Object
Wrapper for i18 t method, with some spice added. If translation is not found English translation value will be returned. And if still not found default value will be returned if passed.
Parameters:
- key
-
String. String to be translated into locale.
- default
-
String. Value returned if translation is not found.
Example:
t('translate.this','Enter text for ....')
Returns: String. Translated text.
117 118 119 120 121 122 123 124 125 |
# File 'app/models/drgcms_form_fields/drgcms_field.rb', line 117 def t(key, default = '') c = I18n.t(key) if c.match(/translation missing/i) c = I18n.t(key, locale: 'en') # Still not found. Return default if set c = default unless default.blank? end c end |