Module: CustomFieldsHelper

Included in:
AccountController, TimelogController, UsersController
Defined in:
app/helpers/custom_fields_helper.rb

Overview

Redmine - project management software Copyright © 2006- Jean-Philippe Lang

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Constant Summary collapse

CUSTOM_FIELDS_TABS = 
[
  {:name => 'IssueCustomField', :partial => 'custom_fields/index',
   :label => :label_issue_plural},
  {:name => 'TimeEntryCustomField', :partial => 'custom_fields/index',
   :label => :label_spent_time},
  {:name => 'ProjectCustomField', :partial => 'custom_fields/index',
   :label => :label_project_plural},
  {:name => 'VersionCustomField', :partial => 'custom_fields/index',
   :label => :label_version_plural},
  {:name => 'DocumentCustomField', :partial => 'custom_fields/index',
   :label => :label_document_plural},
  {:name => 'UserCustomField', :partial => 'custom_fields/index',
   :label => :label_user_plural},
  {:name => 'GroupCustomField', :partial => 'custom_fields/index',
   :label => :label_group_plural},
  {:name => 'TimeEntryActivityCustomField', :partial => 'custom_fields/index',
   :label => TimeEntryActivity::OptionName},
  {:name => 'IssuePriorityCustomField', :partial => 'custom_fields/index',
   :label => IssuePriority::OptionName},
  {:name => 'DocumentCategoryCustomField', :partial => 'custom_fields/index',
   :label => DocumentCategory::OptionName}
]

Instance Method Summary collapse

Instance Method Details

#custom_field_formats_for_select(custom_field) ⇒ Object

Return an array of custom field formats which can be used in select_tag



175
176
177
 
# File 'app/helpers/custom_fields_helper.rb', line 175

def custom_field_formats_for_select(custom_field)
  Redmine::FieldFormat.as_select(custom_field.class.customized_class.name)
end

#custom_field_label_tag(name, custom_value, options = {}) ⇒ Object

Return custom field label tag



110
111
112
113
114
115
116
117
118
119
 
# File 'app/helpers/custom_fields_helper.rb', line 110

def custom_field_label_tag(name, custom_value, options={})
  required = options[:required] || custom_value.custom_field.is_required?
  for_tag_id = options.fetch(:for_tag_id, "#{name}_custom_field_values_#{custom_value.custom_field.id}")
  content = custom_field_name_tag custom_value.custom_field
  content_tag(
    "label", content +
    (required ? " <span class=\"required\">*</span>".html_safe : ""),
    :for => for_tag_id,
    :class => custom_value.customized && custom_value.customized.errors[custom_value.custom_field.name].present? ? 'error' : nil)
end

#custom_field_name_tag(custom_field) ⇒ Object

Return custom field name tag



103
104
105
106
107
 
# File 'app/helpers/custom_fields_helper.rb', line 103

def custom_field_name_tag(custom_field)
  title = custom_field.description.presence
  css = title ? "field-description" : nil
  content_tag 'span', custom_field.name, :title => title, :class => css
end

#custom_field_tag(prefix, custom_value) ⇒ Object

Return custom field html tag corresponding to its format



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'app/helpers/custom_fields_helper.rb', line 80

def custom_field_tag(prefix, custom_value)
  cf = custom_value.custom_field
  css = cf.css_classes
  placeholder = cf.description
  placeholder&.tr!("\n", ' ') if cf.field_format != 'text'
  data = nil
  if cf.full_text_formatting?
    css += ' wiki-edit'
    data = {
      :auto_complete => true
    }
  end
  cf.format.edit_tag(
    self,
    custom_field_tag_id(prefix, cf),
    custom_field_tag_name(prefix, cf),
    custom_value,
    :class => css,
    :placeholder => placeholder,
    :data => data)
end

#custom_field_tag_for_bulk_edit(prefix, custom_field, objects = nil, value = '') ⇒ Object

Returns the custom field tag for when bulk editing objects



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'app/helpers/custom_fields_helper.rb', line 133

def custom_field_tag_for_bulk_edit(prefix, custom_field, objects=nil, value='')
  css =  custom_field.css_classes
  data = nil
  if custom_field.full_text_formatting?
    css += ' wiki-edit'
    data = {
      :auto_complete => true
    }
  end
  custom_field.format.bulk_edit_tag(
    self,
    custom_field_tag_id(prefix, custom_field),
    custom_field_tag_name(prefix, custom_field),
    custom_field,
    objects,
    value,
    :class => css,
    :data => data)
end

#custom_field_tag_id(prefix, custom_field) ⇒ Object 



75
76
77
 
# File 'app/helpers/custom_fields_helper.rb', line 75

def custom_field_tag_id(prefix, custom_field)
  "#{prefix}_custom_field_values_#{custom_field.id}"
end

#custom_field_tag_name(prefix, custom_field) ⇒ Object 



69
70
71
72
73
 
# File 'app/helpers/custom_fields_helper.rb', line 69

def custom_field_tag_name(prefix, custom_field)
  name = "#{prefix}[custom_field_values][#{custom_field.id}]"
  name += "[]" if custom_field.multiple?
  name
end

#custom_field_tag_with_label(name, custom_value, options = {}) ⇒ Object

Return custom field tag with its label tag



122
123
124
125
126
127
128
129
130
 
# File 'app/helpers/custom_fields_helper.rb', line 122

def custom_field_tag_with_label(name, custom_value, options={})
  tag = custom_field_tag(name, custom_value)
  tag_id = nil
  ids = tag.scan(/ id="(.+?)"/)
  if ids.size == 1
    tag_id = ids.first.first
  end
  custom_field_label_tag(name, custom_value, options.merge(:for_tag_id => tag_id)) + tag
end

#custom_field_title(custom_field) ⇒ Object 



53
54
55
56
57
58
59
60
 
# File 'app/helpers/custom_fields_helper.rb', line 53

def custom_field_title(custom_field)
  items = []
  items << [l(:label_custom_field_plural), custom_fields_path]
  items << [l(custom_field.type_name), custom_fields_path(:tab => custom_field.class.name)] if custom_field
  items << (custom_field.nil? || custom_field.new_record? ? l(:label_custom_field_new) : custom_field.name)

  title(*items)
end

#custom_field_type_options ⇒ Object 



49
50
51
 
# File 'app/helpers/custom_fields_helper.rb', line 49

def custom_field_type_options
  CUSTOM_FIELDS_TABS.map {|h| [l(h[:label]), h[:name]]}
end

#custom_field_value_tag(value) ⇒ Object

Returns custom field value tag



154
155
156
157
158
159
160
161
162
 
# File 'app/helpers/custom_fields_helper.rb', line 154

def custom_field_value_tag(value)
  attr_value = show_value(value)

  if attr_value.present? && value.custom_field.full_text_formatting?
    content_tag('div', attr_value, :class => 'wiki')
  else
    attr_value
  end
end

#edit_tag_style_tag(form, options = {}) ⇒ Object 



211
212
213
214
215
216
217
 
# File 'app/helpers/custom_fields_helper.rb', line 211

def edit_tag_style_tag(form, options={})
  select_options = [[l(:label_drop_down_list), ''], [l(:label_checkboxes), 'check_box']]
  if options[:include_radio]
    select_options << [l(:label_radio_buttons), 'radio']
  end
  form.select :edit_tag_style, select_options, :label => :label_display
end

#format_value(value, custom_field) ⇒ Object

Return a string used to display a custom value



170
171
172
 
# File 'app/helpers/custom_fields_helper.rb', line 170

def format_value(value, custom_field)
  format_object(custom_field.format.formatted_value(self, custom_field, value, false), html: false)
end

#render_api_custom_values(custom_values, api) ⇒ Object

Renders the custom_values in api views



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'app/helpers/custom_fields_helper.rb', line 191

def render_api_custom_values(custom_values, api)
  api.array :custom_fields do
    custom_values.each do |custom_value|
      attrs = {:id => custom_value.custom_field_id, :name => custom_value.custom_field.name}
      attrs[:multiple] = true if custom_value.custom_field.multiple?
      api.custom_field attrs do
        if custom_value.value.is_a?(Array)
          api.array :value do
            custom_value.value.each do |value|
              api.value value unless value.blank?
            end
          end
        else
          api.value custom_value.value
        end
      end
    end
  end unless custom_values.empty?
end

#render_custom_field_format_partial(form, custom_field) ⇒ Object 



62
63
64
65
66
67
 
# File 'app/helpers/custom_fields_helper.rb', line 62

def render_custom_field_format_partial(form, custom_field)
  partial = custom_field.format.form_partial
  if partial
    render :partial => custom_field.format.form_partial, :locals => {:f => form, :custom_field => custom_field}
  end
end

#render_custom_field_values(object) ⇒ Object

Yields the given block for each custom field value of object that should be displayed, with the custom field and the formatted value as arguments



181
182
183
184
185
186
187
188
 
# File 'app/helpers/custom_fields_helper.rb', line 181

def render_custom_field_values(object, &)
  object.visible_custom_field_values.each do |custom_value|
    formatted = show_value(custom_value)
    if formatted.present?
      yield custom_value.custom_field, formatted
    end
  end
end

#render_custom_fields_tabs(types) ⇒ Object 



44
45
46
47
 
# File 'app/helpers/custom_fields_helper.rb', line 44

def render_custom_fields_tabs(types)
  tabs = CUSTOM_FIELDS_TABS.select {|h| types.include?(h[:name])}
  render_tabs tabs
end

#select_type_radio_buttons(default_type) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
 
# File 'app/helpers/custom_fields_helper.rb', line 219

def select_type_radio_buttons(default_type)
  if CUSTOM_FIELDS_TABS.none? {|tab| tab[:name] == default_type}
    default_type = 'IssueCustomField'
  end
  custom_field_type_options.map do |name, type|
    content_tag(:label, :style => 'display:block;') do
      radio_button_tag('type', type, type == default_type) + name
    end
  end.join("\n").html_safe
end

#show_value(custom_value, html = true) ⇒ Object

Return a string used to display a custom value



165
166
167
 
# File 'app/helpers/custom_fields_helper.rb', line 165

def show_value(custom_value, html=true)
  format_object(custom_value, html: html)
end