Module: ApplicationHelper

Defined in:
app/helpers/application_helper.rb

Overview

Copyright © 2008-2013 Michael Dvorkin and contributors.

Fat Free CRM is freely distributable under the terms of MIT license. See MIT-LICENSE file or www.opensource.org/licenses/mit-license.php

Instance Method Summary collapse

Instance Method Details

#address_field(form, object, attribute, extra_styles) ⇒ Object

Render a text field that is part of compound address.



326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'app/helpers/application_helper.rb', line 326

def address_field(form, object, attribute, extra_styles)
  hint = "#{t(attribute)}..."
  if object.send(attribute).blank?
    form.text_field(attribute,
      :style   => "margin-top: 6px; #{extra_styles}",
      :placeholder => hint
    )
  else
    form.text_field(attribute,
      :style   => "margin-top: 6px; #{extra_styles}",
      :placeholder => hint
    )
  end
end

#arrow_for(id) ⇒ Object 



100
101
102
 
# File 'app/helpers/application_helper.rb', line 100

def arrow_for(id)
  content_tag(:span, "►".html_safe, :id => "#{id}_arrow", :class => :arrow)
end

#avatar_for(model, args = {}) ⇒ Object

Entities can have associated avatars or gravatars. Only calls Gravatar in production env. Gravatar won’t serve default images if they are not publically available: en.gravatar.com/site/implement/images



302
303
304
305
306
307
308
309
310
311
312
 
# File 'app/helpers/application_helper.rb', line 302

def avatar_for(model, args = {})
  args = { :class => 'gravatar', :size => :large }.merge(args)

  if model.respond_to?(:avatar) and model.avatar.present?
    image_tag(model.avatar.image.url(args[:size]), args)
  else
    args = Avatar.size_from_style!(args) # convert size format :large => '75x75'
    gravatar_image_tag(model.email, args)
  end

end

#col(title, value, last = false, email = false) ⇒ Object

Create a column in the ‘asset_attributes’ table.



408
409
410
411
412
413
414
415
416
417
418
 
# File 'app/helpers/application_helper.rb', line 408

def col(title, value, last = false, email = false)
  # Parse and format urls as links.
  fmt_value = (value.to_s || "").gsub("\n", "<br />")
  fmt_value = if email
      link_to_email(fmt_value)
    else
      fmt_value.gsub(/((http|ftp|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&amp;:\/\+#]*[\w\-\@?^=%&amp;\/\+#])?)/, "<a href=\"\\1\">\\1</a>")
    end
  last_class = (last ? 'last' : nil)
  content_tag(:th, title, class: last_class) + content_tag(:td, fmt_value, class: last_class)
end

#confirm_delete(model, params = {}) ⇒ Object 



213
214
215
216
217
218
219
220
 
# File 'app/helpers/application_helper.rb', line 213

def confirm_delete(model, params = {})
  question = %(<span class="warn">#{t(:confirm_delete, model.class.to_s.downcase)}</span>)
  yes = link_to(t(:yes_button), params[:url] || model, :method => :delete)
  no = link_to_function(t(:no_button), "$('#menu').html($('#confirm').html());")
  text = "$('#confirm').html( $('#menu').html() );\n"
  text << "$('#menu').html('#{question} #{yes} : #{no}');"
  text.html_safe
end

#current_view_name ⇒ Object

Return name of current view



436
437
438
439
440
 
# File 'app/helpers/application_helper.rb', line 436

def current_view_name
  controller = params['controller']
  action = (params['action'] == 'show') ? 'show' : 'index' # create update redraw filter index actions all use index view
  current_user.pref[:"#{controller}_#{action}_view"]
end

#entity_filter_checkbox(name, value, count) ⇒ Object 



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'app/helpers/application_helper.rb', line 389

def entity_filter_checkbox(name, value, count)
  checked = (session["#{controller_name}_filter"].present? ? session["#{controller_name}_filter"].split(",").include?(value.to_s) : count.to_i > 0)
  url = url_for(:action => :filter)
  onclick = %Q{
    var query = $('#query').val(),
        values = [];
    $('input[name=&quot;#{h name}[]&quot;]').filter(':checked').each(function () {
      values.push(this.value);
    });
    $('#loading').show();
    $.post('#{url}', {#{h name}: values.join(','), query: query}, function () {
      $('#loading').hide();
    });
  }.html_safe
  check_box_tag("#{name}[]", value, checked, :id => value, :onclick => onclick)
end

#exposed ⇒ Object 



193
 
# File 'app/helpers/application_helper.rb', line 193

def exposed;   { :style => "display:block;"      }; end

#generate_js_for_popups(related, *assets) ⇒ Object 



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

def generate_js_for_popups(related, *assets)
  assets.map do |asset|
    render(:partial => "shared/select_popup", :locals => { :related => related, :popup => asset })
  end.join
end

#get_browser_timezone_offset ⇒ Object

Ajax helper to pass browser timezone offset to the server.



292
293
294
295
296
 
# File 'app/helpers/application_helper.rb', line 292

def get_browser_timezone_offset
  unless session[:timezone_offset]
    "$.get('#{timezone_path}', {offset: (new Date()).getTimezoneOffset()});"
  end
end

#get_default_permissions_intro(access, text) ⇒ Object

Returns default permissions intro.



316
317
318
319
320
321
322
 
# File 'app/helpers/application_helper.rb', line 316

def get_default_permissions_intro(access, text)
  case access
    when "Private" then t(:permissions_intro_private, text)
    when "Public"  then t(:permissions_intro_public,  text)
    when "Shared"  then t(:permissions_intro_shared,  text)
  end
end

#get_icon(name) ⇒ Object

Translate List name to FontAwesome icon text



488
489
490
491
492
493
494
495
496
497
498
 
# File 'app/helpers/application_helper.rb', line 488

def get_icon(name)
  case name
    when "tasks" then "fa-check-square-o"
    when "campaigns" then "fa-bar-chart-o"
    when "leads" then "fa-tasks"
    when "accounts" then "fa-users"
    when "contacts" then "fa-user"
    when "opportunities" then "fa-money"
    when "team" then "fa-globe"
  end
end

#group_options ⇒ Object 



381
382
383
 
# File 'app/helpers/application_helper.rb', line 381

def group_options
  Group.all.map {|g| [g.name, g.id]}
end

#hidden ⇒ Object 



192
 
# File 'app/helpers/application_helper.rb', line 192

def hidden;    { :style => "display:none;"       }; end

#hidden_if(you_ask) ⇒ Object 



203
204
205
 
# File 'app/helpers/application_helper.rb', line 203

def hidden_if(you_ask)
  you_ask ? hidden : exposed
end

#invisible ⇒ Object 



194
 
# File 'app/helpers/application_helper.rb', line 194

def invisible; { :style => "visibility:hidden;"  }; end

#invisible_if(you_ask) ⇒ Object 



208
209
210
 
# File 'app/helpers/application_helper.rb', line 208

def invisible_if(you_ask)
  you_ask ? invisible : visible
end

#jumpbox(current) ⇒ Object 



178
179
180
181
182
183
184
 
# File 'app/helpers/application_helper.rb', line 178

def jumpbox(current)
  tabs = [ :campaigns, :accounts, :leads, :contacts, :opportunities ]
  current = tabs.first unless tabs.include?(current)
  tabs.map do |tab|
    link_to_function(t("tab_#{tab}"), "crm.jumper('#{tab}')", "html-data" => tab, :class => (tab == current ? 'selected' : ''))
  end.join(" | ").html_safe
end

#link_to_cancel(url, params = {}) ⇒ Object 



142
143
144
145
146
147
148
 
# File 'app/helpers/application_helper.rb', line 142

def link_to_cancel(url, params = {})
  url = params[:url] if params[:url]
  link_to(t(:cancel),
    url + "#{url.include?('?') ? '&' : '?'}cancel=true",
    :remote => true
  )
end

#link_to_close(url) ⇒ Object 



151
152
153
154
155
156
157
 
# File 'app/helpers/application_helper.rb', line 151

def link_to_close(url)
  link_to("x", url + "#{url.include?('?') ? '&' : '?'}cancel=true",
    :remote => true,
    :class => "close",
    :title => t(:close_form)
  )
end

#link_to_delete(record, options = {}) ⇒ Object 



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

def link_to_delete(record, options = {})
  object = record.is_a?(Array) ? record.last : record
  confirm = options[:confirm] || nil

  link_to(t(:delete) + "!",
    options[:url] || url_for(record),
    :method => :delete,
    :remote => true,
    :confirm => confirm
  )
end

#link_to_discard(object) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
 
# File 'app/helpers/application_helper.rb', line 130

def link_to_discard(object)
  current_url = (request.xhr? ? request.referer : request.fullpath)
  parent, parent_id = current_url.scan(%r|/(\w+)/(\d+)|).flatten

  link_to(t(:discard),
    url_for(:controller => parent, :action => :discard, :id => parent_id, :attachment => object.class.name, :attachment_id => object.id),
    :method  => :post,
    :remote  => true
  )
end

#link_to_edit(record, options = {}) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
 
# File 'app/helpers/application_helper.rb', line 105

def link_to_edit(record, options = {})
  object = record.is_a?(Array) ? record.last : record

  name = (params[:klass_name] || object.class.name).underscore.downcase
  link_to(t(:edit),
    options[:url] || polymorphic_url(record, :action => :edit),
    :remote  => true,
    :onclick => "this.href = this.href.split('?')[0] + '?previous='+crm.find_form('edit_#{h name}');".html_safe
  )
end

#link_to_email(email, length = nil, &block) ⇒ Object

Bcc: to dropbox address if the dropbox has been set up.



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'app/helpers/application_helper.rb', line 161

def link_to_email(email, length = nil, &block)
  name = (length ? truncate(email, :length => length) : email)
  if Setting.email_dropbox && Setting.email_dropbox[:address].present?
    mailto = "#{email}?bcc=#{Setting.email_dropbox[:address]}"
  else
    mailto = email
  end
  if block_given?
    link_to("mailto:#{mailto}", :title => email) do
      yield
    end
  else
    link_to(h(name), "mailto:#{mailto}", :title => email)
  end
end

#link_to_inline(id, url, options = {}) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'app/helpers/application_helper.rb', line 86

def link_to_inline(id, url, options = {})
  text = options[:text] || t(id, :default => id.to_s.titleize)
  text = (arrow_for(id) + text) unless options[:plain]
  related = (options[:related] ? "&related=#{options[:related]}" : '')

  link_to(text,
    url + "#{url.include?('?') ? '&' : '?'}cancel=false" + related,
    :remote => true,
    :onclick => "this.href = this.href.replace(/cancel=(true|false)/,'cancel='+ ($('##{id}').css('display') != 'none'));",
    :class => options[:class]
  )
end

#links_to_export(action = :index) ⇒ Object

Helper to display links to supported data export formats.



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'app/helpers/application_helper.rb', line 353

def links_to_export(action=:index)
  token = current_user.single_access_token
  url_params = {:action => action}
  url_params.merge!(:id => params[:id]) unless params[:id].blank?
  url_params.merge!(:query => params[:query]) unless params[:query].blank?
  url_params.merge!(:q => params[:q]) unless params[:q].blank?
  url_params.merge!(:view => @view) unless @view.blank? # tasks
  url_params.merge!(:id => params[:id]) unless params[:id].blank?

  exports = %w(xls csv).map do |format|
    link_to(format.upcase, url_params.merge(:format => format), :title => I18n.t(:"to_#{format}")) unless action.to_s == "show"
  end

  feeds = %w(rss atom).map do |format|
    link_to(format.upcase, url_params.merge(:format => format, :authentication_credentials => token), :title => I18n.t(:"to_#{format}"))
  end

  links = %W(perm).map do |format|
    link_to(format.upcase, url_params, :title => I18n.t(:"to_#{format}"))
  end

  (exports + feeds + links).compact.join(' | ')
end

#list_of_entities ⇒ Object 



385
386
387
 
# File 'app/helpers/application_helper.rb', line 385

def list_of_entities
  ENTITIES
end

#load_select_popups_for(related, *assets) ⇒ Object 



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

def load_select_popups_for(related, *assets)
  js = generate_js_for_popups(related, *assets)
  content_for(:javascript_epilogue) do
    raw "$(function() { #{js} });"
  end
end

#one_submit_only(form = '') ⇒ Object 



198
199
200
 
# File 'app/helpers/application_helper.rb', line 198

def one_submit_only(form='')
  { :onsubmit => "$('#'+this.id+' input[type=submit]').prop('disabled', true)".html_safe }
end

#options_menu_item(option, key, url = send("redraw_#{controller.controller_name}_path")) ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'app/helpers/application_helper.rb', line 276

def options_menu_item(option, key, url = send("redraw_#{controller.controller_name}_path"))
  name = t("option_#{key}")
  "{ name: \"#{name.titleize}\", on_select: function() {" +
  %Q{
    if ($('##{option}').html() != '#{name}') {
      $('##{option}').html('#{name}');
      $('#loading').show();
      $.get('#{url}', {#{option}: '#{key}', query: $('#query').val()}, function () {
        $('#loading').hide();
      });
    }
  } + "}}"
end

#paginate(options = {}) ⇒ Object

Ajaxification FTW! e.g. collection = Opportunity.my.scope

options = { renderer: {...} , params: {...}



504
505
506
507
508
 
# File 'app/helpers/application_helper.rb', line 504

def paginate(options = {})
  collection = options.delete(:collection)
  options = { renderer: RemoteLinkPaginationHelper::LinkRenderer }.merge(options)
  will_paginate(collection, options)
end

#rating_select(name, options = {}) ⇒ Object

We need this because standard Rails [select] turns &#9733; into &amp;#9733;



78
79
80
81
82
83
 
# File 'app/helpers/application_helper.rb', line 78

def rating_select(name, options = {})
  stars = Hash[ (1..5).map { |star| [ star, "&#9733;" * star ] } ].sort
  options_for_select = %Q(<option value="0"#{options[:selected].to_i == 0 ? ' selected="selected"' : ''}>#{t :select_none}</option>)
  options_for_select << stars.map { |star| %(<option value="#{star.first}"#{options[:selected] == star.first ? ' selected="selected"' : ''}>#{star.last}</option>) }.join
  select_tag name, options_for_select.html_safe, options
end

#redraw(option, value, url = send("redraw_#{controller.controller_name}_path")) ⇒ Object

Ajax helper to refresh current index page once the user selects an option.



260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'app/helpers/application_helper.rb', line 260

def redraw(option, value, url = send("redraw_#{controller.controller_name}_path"))
  if value.is_a?(Array)
    param, value = value.first, value.last
  end
  %Q{
    if ($('##{option}').html() != '#{value}') {
      $('##{option}').html('#{value}');
      $('#loading').show();
      $.post('#{url}', {#{option}: '#{param || value}'}, function () {
        $('#loading').hide();
      });
    }
  }
end

#refresh_sidebar(action = nil, shake = nil) ⇒ Object

Reresh sidebar using the action view within the current controller.



229
230
231
 
# File 'app/helpers/application_helper.rb', line 229

def refresh_sidebar(action = nil, shake = nil)
  refresh_sidebar_for(controller.controller_name, action, shake)
end

#refresh_sidebar_for(view, action = nil, shake = nil) ⇒ Object

Refresh sidebar using the action view within an arbitrary controller.



235
236
237
238
239
240
 
# File 'app/helpers/application_helper.rb', line 235

def refresh_sidebar_for(view, action = nil, shake = nil)
  text = ""
  text << "$('#sidebar').html('#{ j render(:partial => "layouts/sidebar", :locals => { :view => view, :action => action }) }');"
  text << "$('##{j shake.to_s}').effect('shake', { duration:200, distance: 3 });" if shake
  text.html_safe
end

#section(related, assets) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'app/helpers/application_helper.rb', line 48

def section(related, assets)
  asset = assets.to_s.singularize
  create_id  = "create_#{asset}"
  select_id  = "select_#{asset}"
  create_url = controller.send(:"new_#{asset}_path")

  html = tag(:br)
  html << content_tag(:div, link_to(t(select_id), "#", :id => select_id), :class => "subtitle_tools")
  html << content_tag(:div, "&nbsp;|&nbsp;".html_safe, :class => "subtitle_tools")
  html << content_tag(:div, link_to_inline(create_id, create_url, :related => dom_id(related), :text => t(create_id)), :class => "subtitle_tools")
  html << content_tag(:div, t(assets), :class => :subtitle, :id => "create_#{asset}_title")
  html << content_tag(:div, "", :class => :remote, :id => create_id, :style => "display:none;")
end

#section_title(id, hidden = true, text = nil, info_text = nil) ⇒ Object

Combines the ‘subtitle’ helper with the small info text on the same line.



422
423
424
425
426
427
428
429
430
431
432
 
# File 'app/helpers/application_helper.rb', line 422

def section_title(id, hidden = true, text = nil, info_text = nil)
  text = id.to_s.split("_").last.capitalize if text == nil
  content_tag("div", :class => "subtitle show_attributes") do
    content = link_to("<small>#{ hidden ? "&#9658;" : "&#9660;" }</small> #{sanitize text}".html_safe,
      url_for(:controller => :home, :action => :toggle, :id => id),
      :remote  => true,
      :onclick => "crm.flip_subtitle(this)"
    )
    content << content_tag("small", info_text.to_s, {:class => "subtitle_inline_info", :id => "#{id}_intro", :style => hidden ? "" : "display:none;"})
  end
end

#show_flash(options = { :sticky => false }) ⇒ Object

Show existing flash or embed hidden paragraph ready for flash



26
27
28
29
30
31
32
33
34
35
 
# File 'app/helpers/application_helper.rb', line 26

def show_flash(options = { :sticky => false })
  [:error, :warning, :info, :notice].each do |type|
    if flash[type]
      html = content_tag(:div, h(flash[type]), :id => "flash")
      flash[type] = nil
      return html << content_tag(:script, "crm.flash('#{type}', #{options[:sticky]})".html_safe, :type => "text/javascript")
    end
  end
  content_tag(:p, nil, :id => "flash", :style => "display:none;")
end

#shown_on_landing_page? ⇒ Boolean

Return true if:

- it's an Ajax request made from the asset landing page (i.e. create opportunity
  from a contact landing page) OR
- we're actually showing asset landing page.

Returns:

  • (Boolean) 


346
347
348
349
 
# File 'app/helpers/application_helper.rb', line 346

def shown_on_landing_page?
  !!((request.xhr? && request.referer =~ %r|/\w+/\d+|) ||
     (!request.xhr? && request.fullpath =~ %r|/\w+/\d+|))
end

#spacer(width = 10) ⇒ Object 



223
224
225
 
# File 'app/helpers/application_helper.rb', line 223

def spacer(width = 10)
  image_tag "1x1.gif", :width => width, :height => 1, :alt => nil
end

#styles_for(*models) ⇒ Object 



187
188
189
 
# File 'app/helpers/application_helper.rb', line 187

def styles_for(*models)
  render :partial => "shared/inline_styles", :locals => { :models => models }
end

#subtitle(id, hidden = true, text = id.to_s.split("_").last.capitalize) ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'app/helpers/application_helper.rb', line 38

def subtitle(id, hidden = true, text = id.to_s.split("_").last.capitalize)
  content_tag("div",
    link_to("<small>#{ hidden ? "&#9658;" : "&#9660;" }</small> #{sanitize text}".html_safe,
      url_for(:controller => :home, :action => :toggle, :id => id),
      :remote => true,
      :onclick => "crm.flip_subtitle(this)"
    ), :class => "subtitle")
end

#tabless_layout? ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
22
 
# File 'app/helpers/application_helper.rb', line 19

def tabless_layout?
  %w(authentications passwords).include?(controller.controller_name) ||
  ((controller.controller_name == "users") && (%w(create new).include?(controller.action_name)))
end

#tabs(tabs = nil) ⇒ Object 



8
9
10
11
12
13
14
15
16
 
# File 'app/helpers/application_helper.rb', line 8

def tabs(tabs = nil)
  tabs ||= controller_path =~ /admin/ ? FatFreeCRM::Tabs.admin : FatFreeCRM::Tabs.main
  if tabs
    @current_tab ||= tabs.first[:text] # Select first tab by default.
    tabs.each { |tab| tab[:active] = (@current_tab == tab[:text] || @current_tab == tab[:url][:controller]) }
  else
    raise FatFreeCRM::MissingSettings, "Tab settings are missing, please run <b>rake ffcrm:setup</b> command."
  end
end

#template_for_current_view ⇒ Object

Get template in current context with current view name



444
445
446
447
448
449
 
# File 'app/helpers/application_helper.rb', line 444

def template_for_current_view
  controller = params['controller']
  action = (params['action'] == 'show') ? 'show' : 'index' # create update redraw filter index actions all use index view
  template = FatFreeCRM::ViewFactory.template_for_current_view(:controller => controller, :action => action, :name => current_view_name)
  template
end

#timeago(time, options = {}) ⇒ Object

Generate the html for $.timeago function <span class=“timeago” datetime=“2008-07-17T09:24:17Z”>July 17, 2008</span>



481
482
483
484
 
# File 'app/helpers/application_helper.rb', line 481

def timeago(time, options = {})
  options[:class] ||= "timeago"
  content_tag(:span, h(time.to_s), options.merge( title: time.getutc.iso8601)) if time
end

#user_options ⇒ Object 



377
378
379
 
# File 'app/helpers/application_helper.rb', line 377

def user_options
  User.all.map {|u| [u.full_name, u.id]}
end

#view_buttons ⇒ Object

Generate buttons for available views given the current context



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'app/helpers/application_helper.rb', line 453

def view_buttons
  controller = params['controller']
  action = (params['action'] == 'show') ? 'show' : 'index' # create update redraw filter index actions all use index view
  views = FatFreeCRM::ViewFactory.views_for(:controller => controller, :action => action)
  return nil unless views.size > 1
  lis = ''.html_safe
  content_tag :ul, :class => 'format-buttons' do
    views.collect do |view|
      classes = if (current_view_name == view.name) or (current_view_name == nil and view.template == nil) # nil indicates default template.
          "#{h view.name}-button active"
        else
          "#{h view.name}-button"
        end
      lis << content_tag(:li) do
        url = (action == "index") ? send("redraw_#{controller}_path") : send("#{controller.singularize}_path")
        link_to('#', :title => t(view.name, :default => h(view.title)), :"data-view" => h(view.name), :"data-url" => h(url), :"data-context" => action, :class => classes) do
          icon = view.icon || 'fa-bars'
          content_tag(:i, nil, class: "fa #{h icon}")
        end
      end
    end
    lis
  end
end

#visible ⇒ Object 



195
 
# File 'app/helpers/application_helper.rb', line 195

def visible;   { :style => "visibility:visible;" }; end

#web_presence_icons(person) ⇒ Object

Display web presence mini-icons for Contact or Lead.



244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'app/helpers/application_helper.rb', line 244

def web_presence_icons(person)
  [ :blog, :linkedin, :facebook, :twitter, :skype ].map do |site|
    url = person.send(site)
    unless url.blank?
      if site == :skype then
        url = "callto:" << url
      else
        url = "http://" << url unless url.match(/^https?:\/\//)
      end
      link_to(image_tag("#{site}.gif", :size => "15x15"), h(url), :"data-popup" => true, :title => t(:open_in_window, h(url)))
    end
  end.compact.join("\n").html_safe
end