Module: CustomFieldsHelper

Overview

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

Instance Method Summary collapse

Instance Method Details

#custom_field_formats_for_selectObject

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



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

def custom_field_formats_for_select
  Redmine::CustomFieldFormat.as_select
end

#custom_field_label_tag(name, custom_value) ⇒ Object

Return custom field label tag



59
60
61
62
63
64
# File 'app/helpers/custom_fields_helper.rb', line 59

def custom_field_label_tag(name, custom_value)
   "label", custom_value.custom_field.name +
	(custom_value.custom_field.is_required? ? " <span class=\"required\">*</span>" : ""),
	:for => "#{name}_custom_field_values_#{custom_value.custom_field.id}",
	:class => (custom_value.errors.empty? ? nil : "error" )
end

#custom_field_tag(name, custom_value) ⇒ Object

Return custom field html tag corresponding to its format



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'app/helpers/custom_fields_helper.rb', line 34

def custom_field_tag(name, custom_value)	
  custom_field = custom_value.custom_field
  field_name = "#{name}[custom_field_values][#{custom_field.id}]"
  field_id = "#{name}_custom_field_values_#{custom_field.id}"

  field_format = Redmine::CustomFieldFormat.find_by_name(custom_field.field_format)
  case field_format.try(:edit_as)
  when "date"
    text_field_tag(field_name, custom_value.value, :id => field_id, :size => 10) + 
    calendar_for(field_id)
  when "text"
    text_area_tag(field_name, custom_value.value, :id => field_id, :rows => 3, :style => 'width:90%')
  when "bool"
    hidden_field_tag(field_name, '0') + check_box_tag(field_name, '1', custom_value.true?, :id => field_id)
  when "list"
    blank_option = custom_field.is_required? ?
                     (custom_field.default_value.blank? ? "<option value=\"\">--- #{l(:actionview_instancetag_blank_option)} ---</option>" : '') : 
                     '<option></option>'
    select_tag(field_name, blank_option + options_for_select(custom_field.possible_values, custom_value.value), :id => field_id)
  else
    text_field_tag(field_name, custom_value.value, :id => field_id)
  end
end

#custom_field_tag_for_bulk_edit(name, custom_field) ⇒ Object



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'app/helpers/custom_fields_helper.rb', line 71

def custom_field_tag_for_bulk_edit(name, custom_field)
  field_name = "#{name}[custom_field_values][#{custom_field.id}]"
  field_id = "#{name}_custom_field_values_#{custom_field.id}"
  field_format = Redmine::CustomFieldFormat.find_by_name(custom_field.field_format)
  case field_format.try(:edit_as)
    when "date"
      text_field_tag(field_name, '', :id => field_id, :size => 10) + 
      calendar_for(field_id)
    when "text"
      text_area_tag(field_name, '', :id => field_id, :rows => 3, :style => 'width:90%')
    when "bool"
      select_tag(field_name, options_for_select([[l(:label_no_change_option), ''],
                                                 [l(:general_text_yes), '1'],
                                                 [l(:general_text_no), '0']]), :id => field_id)
    when "list"
      select_tag(field_name, options_for_select([[l(:label_no_change_option), '']] + custom_field.possible_values), :id => field_id)
    else
      text_field_tag(field_name, '', :id => field_id)
  end
end

#custom_field_tag_with_label(name, custom_value) ⇒ Object

Return custom field tag with its label tag



67
68
69
# File 'app/helpers/custom_fields_helper.rb', line 67

def custom_field_tag_with_label(name, custom_value)
  custom_field_label_tag(name, custom_value) + custom_field_tag(name, custom_value)
end

#custom_fields_tabsObject



20
21
22
23
24
25
26
27
28
29
30
31
# File 'app/helpers/custom_fields_helper.rb', line 20

def custom_fields_tabs
  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 => '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}
          ]
end

#format_value(value, field_format) ⇒ Object

Return a string used to display a custom value



99
100
101
# File 'app/helpers/custom_fields_helper.rb', line 99

def format_value(value, field_format)
  Redmine::CustomFieldFormat.format_value(value, field_format) # Proxy
end

#render_api_custom_values(custom_values, api) ⇒ Object

Renders the custom_values in api views



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

def render_api_custom_values(custom_values, api)
  api.array :custom_fields do
    custom_values.each do |custom_value|
      api.custom_field :id => custom_value.custom_field_id, :name => custom_value.custom_field.name do
        api.value custom_value.value
      end
    end
  end unless custom_values.empty?
end

#show_value(custom_value) ⇒ Object

Return a string used to display a custom value



93
94
95
96
# File 'app/helpers/custom_fields_helper.rb', line 93

def show_value(custom_value)
  return "" unless custom_value
  format_value(custom_value.value, custom_value.custom_field.field_format)
end