Module: ApplicationHelper
- Extends:
- Forwardable
- Includes:
- GravatarHelper::PublicMethods, Redmine::I18n, Redmine::WikiFormatting::Macros::Definitions
- Included in:
- IssuesHelper, Redmine::Hook::ViewListener, TimelogHelper
- Defined in:
- lib/redmine/themes.rb,
app/helpers/application_helper.rb
Instance Method Summary
- - (Object) accesskey(s)
- - (Object) authoring(created, author, options = {})
-
- (Object) authorize_for(controller, action)
Return true if user is authorized for controller/action, otherwise false.
-
- (Object) avatar(user, options = { })
Returns the avatar image tag for the given user if avatars are enabled user can be a User or a string that will be scanned for an email address (eg. ‘joe <joe@foo.bar>’).
- - (Object) back_url_hidden_field_tag
- - (Object) breadcrumb(*args)
- - (Object) calendar_for(field_id)
- - (Object) check_all_links(form_name)
- - (Object) checked_image(checked = true)
- - (Object) content_for(name, content = nil, &block)
- - (Object) context_menu(url)
- - (Object) context_menu_link(name, url, options = {})
- - (Object) due_date_distance_in_words(date)
- - (Object) format_activity_day(date)
- - (Object) format_activity_description(text)
- - (Object) format_activity_title(text)
- - (Object) format_version_name(version)
- - (Boolean) has_content?(name)
- - (Object) html_hours(text)
- - (Object) html_title(*args)
- - (Object) image_to_function(name, function, html_options = {})
- - (Object) include_calendar_headers_tags
- - (Object) label_tag_for(name, option_tags = nil, options = {})
- - (Object) labelled_tabular_form_for(name, object, options, &proc)
- - (Object) lang_options_for_select(blank = true)
-
- (Object) link_to_attachment(attachment, options = {})
Generates a link to an attachment.
-
- (Object) link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference)
Display a link if user is authorized.
-
- (Object) link_to_issue(issue, options = {})
Displays a link to issue with its subject.
-
- (Object) link_to_remote_if_authorized(name, options = {}, html_options = nil)
Display a link to remote if user is authorized.
-
- (Object) link_to_revision(revision, project, options = {})
Generates a link to a SCM revision Options:
- :text - Link text (default to the formatted revision).
-
- (Object) link_to_user(user, options = {})
Displays a link to user’s account page if active.
- - (Object) other_formats_links {|Redmine::Views::OtherFormatsBuilder.new(self)| ... }
- - (Object) page_header_title
- - (Object) pagination_links_full(paginator, count = nil, options = {})
- - (Object) parse_inline_attachments(text, project, obj, attr, only_path, options)
- - (Object) parse_non_pre_blocks(text)
-
- (Object) parse_redmine_links(text, project, obj, attr, only_path, options)
Redmine links.
-
- (Object) parse_wiki_links(text, project, obj, attr, only_path, options)
Wiki links.
- - (Object) path_to_stylesheet(source)
- - (Object) per_page_links(selected = nil)
- - (Object) principals_check_box_tags(name, principals)
- - (Object) progress_bar(pcts, options = {})
- - (Object) project_nested_ul(projects, &block)
-
- (Object) project_tree(projects, &block)
Yields the given block for each project with its level in the tree.
- - (Object) project_tree_options_for_select(projects, options = {})
- - (Object) prompt_to_remote(name, text, param, url, html_options = {})
-
- (Object) render_flash_messages
Renders flash messages.
- - (Object) render_page_hierarchy(pages, node = nil)
-
- (Object) render_project_jump_box
Renders the project quick-jump box.
-
- (Object) render_tabs(tabs)
Renders tabs and their content.
- - (Object) reorder_links(name, url)
-
- (Object) simple_format_without_paragraph(text)
Same as Rails’ simple_format helper without using paragraphs.
- - (Object) stylesheet_path(source)
- - (Object) syntax_highlight(name, content)
-
- (Object) textilizable(*args)
Formats text according to system settings.
- - (Object) time_tag(time)
- - (Object) to_path_param(path)
- - (Object) toggle_link(name, id, options = {})
-
- (Object) truncate_lines(string, options = {})
Truncates at line break after 250 characters or options[:length].
-
- (Object) truncate_single_line(string, *args)
Truncates and returns the string as a single line.
Methods included from Redmine::WikiFormatting::Macros::Definitions
#exec_macro, #extract_macro_options
Methods included from Redmine::I18n
#current_language, #day_name, #find_language, #format_date, #format_time, included, #l, #l_hours, #l_or_humanize, #ll, #month_name, #set_language_if_valid, #valid_languages
Methods included from GravatarHelper::PublicMethods
#gravatar, #gravatar_api_url, #gravatar_for, #gravatar_url
Instance Method Details
- (Object) accesskey(s)
396 397 398 |
# File 'app/helpers/application_helper.rb', line 396 def accesskey(s) Redmine::AccessKeys.key_for s end |
- (Object) authoring(created, author, options = {})
281 282 283 |
# File 'app/helpers/application_helper.rb', line 281 def (created, , ={}) l([:label] || :label_added_time_by, :author => link_to_user(), :age => time_tag(created)) end |
- (Object) authorize_for(controller, action)
Return true if user is authorized for controller/action, otherwise false
30 31 32 |
# File 'app/helpers/application_helper.rb', line 30 def (controller, action) User.current.allowed_to?({:controller => controller, :action => action}, @project) end |
- (Object) avatar(user, options = { })
Returns the avatar image tag for the given user if avatars are enabled user can be a User or a string that will be scanned for an email address (eg. ‘joe <joe@foo.bar>’)
773 774 775 776 777 778 779 780 781 782 783 784 |
# File 'app/helpers/application_helper.rb', line 773 def avatar(user, = { }) if Setting.gravatar_enabled? .merge!({:ssl => Setting.protocol == 'https', :default => Setting.gravatar_default}) email = nil if user.respond_to?(:mail) email = user.mail elsif user.to_s =~ %r{<(.+?)>} email = $1 end return gravatar(email.to_s.downcase, ) unless email.blank? rescue nil end end |
672 673 674 675 676 |
# File 'app/helpers/application_helper.rb', line 672 def back_url_hidden_field_tag back_url = params[:back_url] || request.env['HTTP_REFERER'] back_url = CGI.unescape(back_url.to_s) hidden_field_tag('back_url', CGI.escape(back_url)) unless back_url.blank? end |
- (Object) breadcrumb(*args)
352 353 354 355 |
# File 'app/helpers/application_helper.rb', line 352 def (*args) elements = args.flatten elements.any? ? content_tag('p', args.join(' » ') + ' » ', :class => 'breadcrumb') : nil end |
- (Object) calendar_for(field_id)
733 734 735 736 737 |
# File 'app/helpers/application_helper.rb', line 733 def calendar_for(field_id) image_tag("calendar.png", {:id => "#{field_id}_trigger",:class => "calendar-trigger"}) + javascript_tag("Calendar.setup({inputField : '#{field_id}', ifFormat : '%Y-%m-%d', button : '#{field_id}_trigger' });") end |
- (Object) check_all_links(form_name)
678 679 680 681 682 |
# File 'app/helpers/application_helper.rb', line 678 def check_all_links(form_name) link_to_function(l(:button_check_all), "checkAll('#{form_name}', true)") + " | " + link_to_function(l(:button_uncheck_all), "checkAll('#{form_name}', false)") end |
- (Object) checked_image(checked = true)
700 701 702 703 704 |
# File 'app/helpers/application_helper.rb', line 700 def checked_image(checked=true) if checked image_tag 'toggle_check.png' end end |
- (Object) content_for(name, content = nil, &block)
761 762 763 764 765 |
# File 'app/helpers/application_helper.rb', line 761 def content_for(name, content = nil, &block) @has_content ||= {} @has_content[name] = true super(name, content, &block) end |
706 707 708 709 710 711 712 713 714 715 |
# File 'app/helpers/application_helper.rb', line 706 def (url) unless content_for :header_tags do javascript_include_tag('context_menu') + stylesheet_link_tag('context_menu') end = true end javascript_tag "new ContextMenu('#{ url_for(url) }')" end |
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 |
# File 'app/helpers/application_helper.rb', line 717 def (name, url, ={}) [:class] ||= '' if .delete(:selected) [:class] << ' icon-checked disabled' [:disabled] = true end if .delete(:disabled) .delete(:method) .delete(:confirm) .delete(:onclick) [:class] << ' disabled' url = '#' end link_to name, url, end |
- (Object) due_date_distance_in_words(date)
146 147 148 149 150 |
# File 'app/helpers/application_helper.rb', line 146 def due_date_distance_in_words(date) if date l((date < Date.today ? :label_roadmap_overdue : :label_roadmap_due_in), distance_of_date_in_words(Date.today, date)) end end |
- (Object) format_activity_day(date)
130 131 132 |
# File 'app/helpers/application_helper.rb', line 130 def format_activity_day(date) date == Date.today ? l(:label_today).titleize : format_date(date) end |
- (Object) format_activity_description(text)
134 135 136 |
# File 'app/helpers/application_helper.rb', line 134 def format_activity_description(text) h(truncate(text.to_s, :length => 120).gsub(%r{[\r\n]*<(pre|code)>.*$}m, '...')).gsub(/[\r\n]+/, "<br />") end |
- (Object) format_activity_title(text)
126 127 128 |
# File 'app/helpers/application_helper.rb', line 126 def format_activity_title(text) h(truncate_single_line(text, :length => 100)) end |
- (Object) format_version_name(version)
138 139 140 141 142 143 144 |
# File 'app/helpers/application_helper.rb', line 138 def format_version_name(version) if version.project == @project h(version) else h("#{version.project} - #{version}") end end |
- (Boolean) has_content?(name)
767 768 769 |
# File 'app/helpers/application_helper.rb', line 767 def has_content?(name) (@has_content && @has_content[name]) || false end |
- (Object) html_hours(text)
277 278 279 |
# File 'app/helpers/application_helper.rb', line 277 def html_hours(text) text.gsub(%r{(\d+)\.(\d+)}, '<span class="hours hours-int">\1</span><span class="hours hours-dec">.\2</span>') end |
- (Object) html_title(*args)
383 384 385 386 387 388 389 390 391 392 393 394 |
# File 'app/helpers/application_helper.rb', line 383 def html_title(*args) if args.empty? title = [] title << @project.name if @project title += @html_title if @html_title title << Setting.app_title title.select {|t| !t.blank? }.join(' - ') else @html_title ||= [] @html_title += args end end |
- (Object) image_to_function(name, function, html_options = {})
113 114 115 116 117 118 119 |
# File 'app/helpers/application_helper.rb', line 113 def image_to_function(name, function, = {}) .symbolize_keys! tag(:input, .merge({ :type => "image", :src => image_path(name), :onclick => ([:onclick] ? "#{html_options[:onclick]}; " : "") + "#{function};" })) end |
- (Object) include_calendar_headers_tags
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 |
# File 'app/helpers/application_helper.rb', line 739 def unless = true content_for :header_tags do start_of_week = case Setting.start_of_week.to_i when 1 'Calendar._FD = 1;' # Monday when 7 'Calendar._FD = 0;' # Sunday else '' # use language end javascript_include_tag('calendar/calendar') + javascript_include_tag("calendar/lang/calendar-#{current_language.to_s.downcase}.js") + javascript_tag(start_of_week) + javascript_include_tag('calendar/calendar-setup') + stylesheet_link_tag('calendar') end end end |
- (Object) label_tag_for(name, option_tags = nil, options = {})
661 662 663 664 |
# File 'app/helpers/application_helper.rb', line 661 def label_tag_for(name, = nil, = {}) label_text = l(("field_"+field.to_s.gsub(/\_id$/, "")).to_sym) + (.delete(:required) ? @template.content_tag("span", " *", :class => "required"): "") content_tag("label", label_text) end |
- (Object) labelled_tabular_form_for(name, object, options, &proc)
666 667 668 669 670 |
# File 'app/helpers/application_helper.rb', line 666 def labelled_tabular_form_for(name, object, , &proc) [:html] ||= {} [:html][:class] = 'tabular' unless [:html].has_key?(:class) form_for(name, object, .merge({ :builder => TabularFormBuilder, :lang => current_language}), &proc) end |
- (Object) lang_options_for_select(blank = true)
656 657 658 659 |
# File 'app/helpers/application_helper.rb', line 656 def (blank=true) (blank ? [["(auto)", ""]] : []) + valid_languages.collect{|lang| [ ll(lang.to_s, :general_lang_name), lang.to_s]}.sort{|x,y| x.last <=> y.last } end |
- (Object) link_to_attachment(attachment, options = {})
Generates a link to an attachment. Options:
- :text - Link text (default to attachment filename)
- :download - Force download (default: false)
90 91 92 93 94 95 |
# File 'app/helpers/application_helper.rb', line 90 def (, ={}) text = .delete(:text) || .filename action = .delete(:download) ? 'download' : 'show' link_to(h(text), {:controller => 'attachments', :action => action, :id => , :filename => .filename }, ) end |
- (Object) link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference)
Display a link if user is authorized
35 36 37 |
# File 'app/helpers/application_helper.rb', line 35 def (name, = {}, = nil, *parameters_for_method_reference) link_to(name, , , *parameters_for_method_reference) if ([:controller] || params[:controller], [:action]) end |
- (Object) link_to_issue(issue, options = {})
Displays a link to issue with its subject. Examples:
link_to_issue(issue) # => Defect #6: This is the subject link_to_issue(issue, :truncate => 6) # => Defect #6: This i... link_to_issue(issue, :subject => false) # => Defect #6 link_to_issue(issue, :project => true) # => Foo - Defect #6
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'app/helpers/application_helper.rb', line 67 def link_to_issue(issue, ={}) title = nil subject = nil if [:subject] == false title = truncate(issue.subject, :length => 60) else subject = issue.subject if [:truncate] subject = truncate(subject, :length => [:truncate]) end end s = link_to "#{issue.tracker} ##{issue.id}", {:controller => "issues", :action => "show", :id => issue}, :class => issue.css_classes, :title => title s << ": #{h subject}" if subject s = "#{h issue.project} - " + s if [:project] s end |
- (Object) link_to_remote_if_authorized(name, options = {}, html_options = nil)
Display a link to remote if user is authorized
40 41 42 43 |
# File 'app/helpers/application_helper.rb', line 40 def (name, = {}, = nil) url = [:url] || {} link_to_remote(name, , ) if (url[:controller] || params[:controller], url[:action]) end |
- (Object) link_to_revision(revision, project, options = {})
Generates a link to a SCM revision Options:
- :text - Link text (default to the formatted revision)
100 101 102 103 104 |
# File 'app/helpers/application_helper.rb', line 100 def link_to_revision(revision, project, ={}) text = .delete(:text) || format_revision(revision) link_to(text, {:controller => 'repositories', :action => 'revision', :id => project, :rev => revision}, :title => l(:label_revision_id, revision)) end |
- (Object) link_to_user(user, options = {})
Displays a link to user’s account page if active
46 47 48 49 50 51 52 53 54 55 56 57 |
# File 'app/helpers/application_helper.rb', line 46 def link_to_user(user, ={}) if user.is_a?(User) name = h(user.name([:format])) if user.active? link_to name, :controller => 'users', :action => 'show', :id => user else name end else h(user.to_s) end end |
- (Object) other_formats_links {|Redmine::Views::OtherFormatsBuilder.new(self)| ... }
357 358 359 360 361 |
# File 'app/helpers/application_helper.rb', line 357 def other_formats_links(&block) concat('<p class="other-formats">' + l(:label_export_to)) yield Redmine::Views::OtherFormatsBuilder.new(self) concat('</p>') end |
- (Object) page_header_title
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'app/helpers/application_helper.rb', line 363 def page_header_title if @project.nil? || @project.new_record? h(Setting.app_title) else b = [] ancestors = (@project.root? ? [] : @project.ancestors.visible) if ancestors.any? root = ancestors.shift b << link_to(h(root), {:controller => 'projects', :action => 'show', :id => root, :jump => }, :class => 'root') if ancestors.size > 2 b << '…' ancestors = ancestors[-2, 2] end b += ancestors.collect {|p| link_to(h(p), {:controller => 'projects', :action => 'show', :id => p, :jump => }, :class => 'ancestor') } end b << h(@project) b.join(' » ') end end |
- (Object) pagination_links_full(paginator, count = nil, options = {})
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 |
# File 'app/helpers/application_helper.rb', line 302 def pagination_links_full(paginator, count=nil, ={}) page_param = .delete(:page_param) || :page per_page_links = .delete(:per_page_links) url_param = params.dup # don't reuse query params if filters are present url_param.merge!(:fields => nil, :values => nil, :operators => nil) if url_param.delete(:set_filter) html = '' if paginator.current.previous html << link_to_remote_content_update('« ' + l(:label_previous), url_param.merge(page_param => paginator.current.previous)) + ' ' end html << (pagination_links_each(paginator, ) do |n| link_to_remote_content_update(n.to_s, url_param.merge(page_param => n)) end || '') if paginator.current.next html << ' ' + link_to_remote_content_update((l(:label_next) + ' »'), url_param.merge(page_param => paginator.current.next)) end unless count.nil? html << " (#{paginator.current.first_item}-#{paginator.current.last_item}/#{count})" if per_page_links != false && links = per_page_links(paginator.items_per_page) html << " | #{links}" end end html end |
- (Object) parse_inline_attachments(text, project, obj, attr, only_path, options)
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 |
# File 'app/helpers/application_helper.rb', line 459 def (text, project, obj, attr, only_path, ) # when using an image link, try to use an attachment, if possible if [:attachments] || (obj && obj.respond_to?(:attachments)) = nil text.gsub!(/src="([^\/"]+\.(bmp|gif|jpg|jpeg|png))"(\s+alt="([^"]*)")?/i) do |m| filename, ext, alt, alttext = $1.downcase, $2, $3, $4 ||= ([:attachments] || obj.).sort_by(&:created_on).reverse # search for the picture in attachments if found = .detect { |att| att.filename.downcase == filename } image_url = url_for :only_path => only_path, :controller => 'attachments', :action => 'download', :id => found desc = found.description.to_s.gsub('"', '') if !desc.blank? && alttext.blank? alt = " title=\"#{desc}\" alt=\"#{desc}\"" end "src=\"#{image_url}\"#{alt}" else m end end end end |
- (Object) parse_non_pre_blocks(text)
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'app/helpers/application_helper.rb', line 430 def parse_non_pre_blocks(text) s = StringScanner.new(text) = [] parsed = '' while !s.eos? s.scan(/(.*?)(<(\/)?(pre|code)(.*?)>|\z)/im) text, full_tag, closing, tag = s[1], s[2], s[3], s[4] if .empty? yield text end parsed << text if tag if closing if .last == tag.downcase .pop end else << tag.downcase end parsed << full_tag end end # Close any non closing tags while tag = .pop parsed << "</#{tag}>" end parsed end |
- (Object) parse_redmine_links(text, project, obj, attr, only_path, options)
Redmine links
Examples:
Issues: #52 -> Link to issue #52 Changesets: r52 -> Link to revision 52 commit:a85130f -> Link to scmid starting with a85130f Documents: document#17 -> Link to document with id 17 document:Greetings -> Link to the document with title "Greetings" document:"Some document" -> Link to the document with title "Some document" Versions: version#3 -> Link to version with id 3 version:1.0.0 -> Link to version named "1.0.0" version:"1.0 beta 2" -> Link to version named "1.0 beta 2" Attachments: :file.zip -> Link to the of the current object named file.zip Source files: source:some/file -> Link to the file located at /some/file in the project's repository source:some/file@52 -> Link to the file's revision 52 source:some/file#L120 -> Link to line 120 of the file source:some/file@52#L120 -> Link to line 120 of the file's revision 52 export:some/file -> Force the download of the file Forum : #1218 -> Link to message with id 1218
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 |
# File 'app/helpers/application_helper.rb', line 553 def parse_redmine_links(text, project, obj, attr, only_path, ) text.gsub!(%r{([\s\(,\-\[\>]|^)(!)?(attachment|document|version|commit|source|export|message|project)?((#|r)(\d+)|(:)([^"\s<>][^\s<>]*?|"[^"]+?"))(?=(?=[[:punct:]]\W)|,|\s|\]|<|$)}) do |m| leading, esc, prefix, sep, identifier = $1, $2, $3, $5 || $7, $6 || $8 link = nil if esc.nil? if prefix.nil? && sep == 'r' if project && (changeset = project.changesets.find_by_revision(identifier)) link = link_to("r#{identifier}", {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :rev => changeset.revision}, :class => 'changeset', :title => truncate_single_line(changeset.comments, :length => 100)) end elsif sep == '#' oid = identifier.to_i case prefix when nil if issue = Issue.visible.find_by_id(oid, :include => :status) link = link_to("##{oid}", {:only_path => only_path, :controller => 'issues', :action => 'show', :id => oid}, :class => issue.css_classes, :title => "#{truncate(issue.subject, :length => 100)} (#{issue.status.name})") end when 'document' if document = Document.find_by_id(oid, :include => [:project], :conditions => Project.visible_by(User.current)) link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document}, :class => 'document' end when 'version' if version = Version.find_by_id(oid, :include => [:project], :conditions => Project.visible_by(User.current)) link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version}, :class => 'version' end when 'message' if = Message.find_by_id(oid, :include => [:parent, {:board => :project}], :conditions => Project.visible_by(User.current)) link = link_to h(truncate(.subject, :length => 60)), {:only_path => only_path, :controller => 'messages', :action => 'show', :board_id => .board, :id => .root, :anchor => (.parent ? "message-#{message.id}" : nil)}, :class => 'message' end when 'project' if p = Project.visible.find_by_id(oid) link = link_to h(p.name), {:only_path => only_path, :controller => 'projects', :action => 'show', :id => p}, :class => 'project' end end elsif sep == ':' # removes the double quotes if any name = identifier.gsub(%r{^"(.*)"$}, "\\1") case prefix when 'document' if project && document = project.documents.find_by_title(name) link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document}, :class => 'document' end when 'version' if project && version = project.versions.find_by_name(name) link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version}, :class => 'version' end when 'commit' if project && (changeset = project.changesets.find(:first, :conditions => ["scmid LIKE ?", "#{name}%"])) link = link_to h("#{name}"), {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :rev => changeset.revision}, :class => 'changeset', :title => truncate_single_line(changeset.comments, :length => 100) end when 'source', 'export' if project && project.repository name =~ %r{^[/\\]*(.*?)(@([0-9a-f]+))?(#(L\d+))?$} path, rev, anchor = $1, $3, $5 link = link_to h("#{prefix}:#{name}"), {:controller => 'repositories', :action => 'entry', :id => project, :path => to_path_param(path), :rev => rev, :anchor => anchor, :format => (prefix == 'export' ? 'raw' : nil)}, :class => (prefix == 'export' ? 'source download' : 'source') end when 'attachment' = [:attachments] || (obj && obj.respond_to?(:attachments) ? obj. : nil) if && = .detect {|a| a.filename == name } link = link_to h(.filename), {:only_path => only_path, :controller => 'attachments', :action => 'download', :id => }, :class => 'attachment' end when 'project' if p = Project.visible.find(:first, :conditions => ["identifier = :s OR LOWER(name) = :s", {:s => name.downcase}]) link = link_to h(p.name), {:only_path => only_path, :controller => 'projects', :action => 'show', :id => p}, :class => 'project' end end end end leading + (link || "#{prefix}#{sep}#{identifier}") end end |
- (Object) parse_wiki_links(text, project, obj, attr, only_path, options)
Wiki links
Examples:
[[mypage]] [[mypage|mytext]]
wiki links can refer other project wikis, using project name or identifier:
[[project:]] -> wiki starting page [[project:|mytext]] [[project:mypage]] [[project:mypage|mytext]]
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 |
# File 'app/helpers/application_helper.rb', line 491 def parse_wiki_links(text, project, obj, attr, only_path, ) text.gsub!(/(!)?(\[\[([^\]\n\|]+)(\|([^\]\n\|]+))?\]\])/) do |m| link_project = project esc, all, page, title = $1, $2, $3, $5 if esc.nil? if page =~ /^([^\:]+)\:(.*)$/ link_project = Project.find_by_name($1) || Project.find_by_identifier($1) page = $2 title ||= $1 if page.blank? end if link_project && link_project.wiki # extract anchor anchor = nil if page =~ /^(.+?)\#(.+)$/ page, anchor = $1, $2 end # check if page exists wiki_page = link_project.wiki.find_page(page) url = case [:wiki_links] when :local; "#{title}.html" when :anchor; "##{title}" # used for single-file wiki export else url_for(:only_path => only_path, :controller => 'wiki', :action => 'index', :id => link_project, :page => Wiki.titleize(page), :anchor => anchor) end link_to((title || page), url, :class => ('wiki-page' + (wiki_page ? '' : ' new'))) else # project or wiki doesn't exist all end else all end end end |
- (Object) path_to_stylesheet(source)
73 74 75 |
# File 'lib/redmine/themes.rb', line 73 def path_to_stylesheet(source) stylesheet_path source end |
- (Object) per_page_links(selected = nil)
332 333 334 335 336 337 338 339 340 341 342 343 |
# File 'app/helpers/application_helper.rb', line 332 def per_page_links(selected=nil) url_param = params.dup url_param.clear if url_param.has_key?(:set_filter) links = Setting..collect do |n| n == selected ? n : link_to_remote(n, {:update => "content", :url => params.dup.merge(:per_page => n), :method => :get}, {:href => url_for(url_param.merge(:per_page => n))}) end links.size > 1 ? l(:label_display_per_page, links.join(', ')) : nil end |
- (Object) principals_check_box_tags(name, principals)
254 255 256 257 258 259 260 |
# File 'app/helpers/application_helper.rb', line 254 def (name, principals) s = '' principals.sort.each do |principal| s << "<label>#{ check_box_tag name, principal.id, false } #{h principal}</label>\n" end s end |
- (Object) progress_bar(pcts, options = {})
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 |
# File 'app/helpers/application_helper.rb', line 684 def (pcts, ={}) pcts = [pcts, pcts] unless pcts.is_a?(Array) pcts = pcts.collect(&:round) pcts[1] = pcts[1] - pcts[0] pcts << (100 - pcts[1] - pcts[0]) width = [:width] || '100px;' legend = [:legend] || '' content_tag('table', content_tag('tr', (pcts[0] > 0 ? content_tag('td', '', :style => "width: #{pcts[0]}%;", :class => 'closed') : '') + (pcts[1] > 0 ? content_tag('td', '', :style => "width: #{pcts[1]}%;", :class => 'done') : '') + (pcts[2] > 0 ? content_tag('td', '', :style => "width: #{pcts[2]}%;", :class => 'todo') : '') ), :class => 'progress', :style => "width: #{width};") + content_tag('p', legend, :class => 'pourcent') end |
- (Object) project_nested_ul(projects, &block)
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'app/helpers/application_helper.rb', line 230 def project_nested_ul(projects, &block) s = '' if projects.any? ancestors = [] projects.sort_by(&:lft).each do |project| if (ancestors.empty? || project.is_descendant_of?(ancestors.last)) s << "<ul>\n" else ancestors.pop s << "</li>" while (ancestors.any? && !project.is_descendant_of?(ancestors.last)) ancestors.pop s << "</ul></li>\n" end end s << "<li>" s << yield(project).to_s ancestors << project end s << ("</li></ul>\n" * ancestors.size) end s end |
- (Object) project_tree(projects, &block)
Yields the given block for each project with its level in the tree
219 220 221 222 223 224 225 226 227 228 |
# File 'app/helpers/application_helper.rb', line 219 def project_tree(projects, &block) ancestors = [] projects.sort_by(&:lft).each do |project| while (ancestors.any? && !project.is_descendant_of?(ancestors.last)) ancestors.pop end yield project, ancestors.size ancestors << project end end |
- (Object) project_tree_options_for_select(projects, options = {})
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'app/helpers/application_helper.rb', line 202 def (projects, = {}) s = '' project_tree(projects) do |project, level| name_prefix = (level > 0 ? (' ' * 2 * level + '» ') : '') = {:value => project.id} if project == [:selected] || ([:selected].respond_to?(:include?) && [:selected].include?(project)) [:selected] = 'selected' else [:selected] = nil end .merge!(yield(project)) if block_given? s << content_tag('option', name_prefix + h(project), ) end s end |
- (Object) prompt_to_remote(name, text, param, url, html_options = {})
121 122 123 124 |
# File 'app/helpers/application_helper.rb', line 121 def prompt_to_remote(name, text, param, url, = {}) [:onclick] = "promptToRemote('#{text}', '#{param}', '#{url_for(url)}'); return false;" link_to name, {}, end |
- (Object) render_flash_messages
Renders flash messages
169 170 171 172 173 174 175 |
# File 'app/helpers/application_helper.rb', line 169 def s = '' flash.each do |k,v| s << content_tag('div', v, :class => "flash #{k}") end s end |
- (Object) render_page_hierarchy(pages, node = nil)
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'app/helpers/application_helper.rb', line 152 def render_page_hierarchy(pages, node=nil) content = '' if pages[node] content << "<ul class=\"pages-hierarchy\">\n" pages[node].each do |page| content << "<li>" content << link_to(h(page.pretty_title), {:controller => 'wiki', :action => 'index', :id => page.project, :page => page.title}, :title => (page.respond_to?(:updated_on) ? l(:label_updated_time, distance_of_time_in_words(Time.now, page.updated_on)) : nil)) content << "\n" + render_page_hierarchy(pages, page.id) if pages[page.id] content << "</li>\n" end content << "</ul>\n" end content end |
- (Object) render_project_jump_box
Renders the project quick-jump box
187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'app/helpers/application_helper.rb', line 187 def render_project_jump_box # Retrieve them now to avoid a COUNT query projects = User.current.projects.all if projects.any? s = '<select onchange="if (this.value != \'\') { window.location = this.value; }">' + "<option value=''>#{ l(:label_jump_to_a_project) }</option>" + '<option value="" disabled="disabled">---</option>' s << (projects, :selected => @project) do |p| { :value => url_for(:controller => 'projects', :action => 'show', :id => p, :jump => ) } end s << '</select>' s end end |
- (Object) render_tabs(tabs)
Renders tabs and their content
178 179 180 181 182 183 184 |
# File 'app/helpers/application_helper.rb', line 178 def render_tabs(tabs) if tabs.any? render :partial => 'common/tabs', :locals => {:tabs => tabs} else content_tag 'p', l(:label_no_data), :class => "nodata" end end |
- (Object) reorder_links(name, url)
345 346 347 348 349 350 |
# File 'app/helpers/application_helper.rb', line 345 def reorder_links(name, url) link_to(image_tag('2uparrow.png', :alt => l(:label_sort_highest)), url.merge({"#{name}[move_to]" => 'highest'}), :method => :post, :title => l(:label_sort_highest)) + link_to(image_tag('1uparrow.png', :alt => l(:label_sort_higher)), url.merge({"#{name}[move_to]" => 'higher'}), :method => :post, :title => l(:label_sort_higher)) + link_to(image_tag('1downarrow.png', :alt => l(:label_sort_lower)), url.merge({"#{name}[move_to]" => 'lower'}), :method => :post, :title => l(:label_sort_lower)) + link_to(image_tag('2downarrow.png', :alt => l(:label_sort_lowest)), url.merge({"#{name}[move_to]" => 'lowest'}), :method => :post, :title => l(:label_sort_lowest)) end |
- (Object) simple_format_without_paragraph(text)
Same as Rails’ simple_format helper without using paragraphs
649 650 651 652 653 654 |
# File 'app/helpers/application_helper.rb', line 649 def simple_format_without_paragraph(text) text.to_s. gsub(/\r\n?/, "\n"). # \r\n and \r -> \n gsub(/\n\n+/, "<br /><br />"). # 2+ newline -> 2 br gsub(/([^\n]\n)(?=[^\n])/, '\1<br />') # 1 newline -> br end |
- (Object) stylesheet_path(source)
67 68 69 70 71 |
# File 'lib/redmine/themes.rb', line 67 def stylesheet_path(source) @current_theme ||= Redmine::Themes.theme(Setting.ui_theme) super((@current_theme && @current_theme.stylesheets.include?(source)) ? "/themes/#{@current_theme.dir}/stylesheets/#{source}" : source) end |
- (Object) syntax_highlight(name, content)
294 295 296 |
# File 'app/helpers/application_helper.rb', line 294 def syntax_highlight(name, content) Redmine::SyntaxHighlighting.highlight_by_filename(content, name) end |
- (Object) textilizable(*args)
Formats text according to system settings. 2 ways to call this method:
- with a String: textilizable(text, options)
- with an object and one of its attribute: textilizable(issue, :description, options)
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
# File 'app/helpers/application_helper.rb', line 404 def textilizable(*args) = args.last.is_a?(Hash) ? args.pop : {} case args.size when 1 obj = [:object] text = args.shift when 2 obj = args.shift attr = args.shift text = obj.send(attr).to_s else raise ArgumentError, 'invalid arguments to textilizable' end return '' if text.blank? project = [:project] || @project || (obj && obj.respond_to?(:project) ? obj.project : nil) only_path = .delete(:only_path) == false ? false : true text = Redmine::WikiFormatting.to_html(Setting.text_formatting, text, :object => obj, :attribute => attr) { |macro, args| exec_macro(macro, obj, args) } parse_non_pre_blocks(text) do |text| [:parse_inline_attachments, :parse_wiki_links, :parse_redmine_links].each do |method_name| send method_name, text, project, obj, attr, only_path, end end end |
- (Object) time_tag(time)
285 286 287 288 289 290 291 292 |
# File 'app/helpers/application_helper.rb', line 285 def time_tag(time) text = distance_of_time_in_words(Time.now, time) if @project link_to(text, {:controller => 'projects', :action => 'activity', :id => @project, :from => time.to_date}, :title => format_time(time)) else content_tag('acronym', text, :title => format_time(time)) end end |
- (Object) to_path_param(path)
298 299 300 |
# File 'app/helpers/application_helper.rb', line 298 def to_path_param(path) path.to_s.split(%r{[/\\]}).select {|p| !p.blank?} end |
- (Object) toggle_link(name, id, options = {})
106 107 108 109 110 111 |
# File 'app/helpers/application_helper.rb', line 106 def toggle_link(name, id, ={}) onclick = "Element.toggle('#{id}'); " onclick << ([:focus] ? "Form.Element.focus('#{options[:focus]}'); " : "this.blur(); ") onclick << "return false;" link_to(name, "#", :onclick => onclick) end |
- (Object) truncate_lines(string, options = {})
Truncates at line break after 250 characters or options[:length]
268 269 270 271 272 273 274 275 |
# File 'app/helpers/application_helper.rb', line 268 def truncate_lines(string, ={}) length = [:length] || 250 if string.to_s =~ /\A(.{#{length}}.*?)$/m "#{$1}..." else string end end |
- (Object) truncate_single_line(string, *args)
Truncates and returns the string as a single line
263 264 265 |
# File 'app/helpers/application_helper.rb', line 263 def truncate_single_line(string, *args) truncate(string.to_s, *args).gsub(%r{[\r\n]+}m, ' ') end |