Module: CustomFieldsHelper

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

Overview

Redmine - project management software Copyright (C) 2006-2017 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.

Since:

  • 0.4.0

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



140
141
142
 
# File 'app/helpers/custom_fields_helper.rb', line 140

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



97
98
99
100
101
102
103
104
105
 
# File 'app/helpers/custom_fields_helper.rb', line 97

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
end

#custom_field_name_tag(custom_field) ⇒ Object

Return custom field name tag

Since:

  • 3.1.0



90
91
92
93
94
 
# File 'app/helpers/custom_fields_helper.rb', line 90

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



81
82
83
84
85
86
87
 
# File 'app/helpers/custom_fields_helper.rb', line 81

def custom_field_tag(prefix, custom_value)
  custom_value.custom_field.format.edit_tag self,
    custom_field_tag_id(prefix, custom_value.custom_field),
    custom_field_tag_name(prefix, custom_value.custom_field),
    custom_value,
    :class => "#{custom_value.custom_field.field_format}_cf"
end

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

Returns the custom field tag for when bulk editing objects

Since:

  • 0.9.0



119
120
121
122
123
124
125
126
127
 
# File 'app/helpers/custom_fields_helper.rb', line 119

def custom_field_tag_for_bulk_edit(prefix, custom_field, objects=nil, value='')
  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 => "#{custom_field.field_format}_cf"
end

#custom_field_tag_id(prefix, custom_field) ⇒ Object

Since:

  • 2.5.0



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

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

#custom_field_tag_name(prefix, custom_field) ⇒ Object

Since:

  • 2.5.0



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

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



108
109
110
111
112
113
114
115
116
 
# File 'app/helpers/custom_fields_helper.rb', line 108

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

Since:

  • 3.2.0



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

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

Since:

  • 2.5.0



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

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

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

Since:

  • 2.5.0



176
177
178
179
180
181
182
 
# File 'app/helpers/custom_fields_helper.rb', line 176

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



135
136
137
 
# File 'app/helpers/custom_fields_helper.rb', line 135

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

#render_api_custom_values(custom_values, api) ⇒ Object

Renders the custom_values in api views

Since:

  • 1.1.0



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'app/helpers/custom_fields_helper.rb', line 156

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.merge!(: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

Since:

  • 2.5.0



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

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, &block) ⇒ 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

Since:

  • 3.0.0



146
147
148
149
150
151
152
153
 
# File 'app/helpers/custom_fields_helper.rb', line 146

def render_custom_field_values(object, &block)
  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

Since:

  • 2.5.0



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

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

#show_value(custom_value, html = true) ⇒ Object

Return a string used to display a custom value



130
131
132
 
# File 'app/helpers/custom_fields_helper.rb', line 130

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