Included Modules

Class Index [+]

Quicksearch

ActionView::Helpers::UrlHelper

Provides a set of methods for making links and getting URLs that depend on the routing subsystem (see ActionDispatch::Routing). This allows you to use the same format for links in views and controllers.

Public Instance Methods

button_to(name, options = {}, html_options = {}) click to toggle source

Generates a form containing a single button that submits to the URL created by the set of options. This is the safest method to ensure links that cause changes to your data are not triggered by search bots or accelerators. If the HTML button does not work with your layout, you can also consider using the link_to method with the :method modifier as described in the link_to documentation.

The generated form element has a class name of button_to to allow styling of the form itself and its children. You can control the form submission and input element behavior using html_options. This method accepts the :method and :confirm modifiers described in the link_to documentation. If no :method modifier is given, it will default to performing a POST operation. You can also disable the button by passing :disabled => true in html_options. If you are using RESTful routes, you can pass the :method to change the HTTP verb used to submit the form.

Options

The options hash accepts the same options as url_for.

There are a few special html_options:

  • :method - Symbol of HTTP verb. Supported verbs are :post, :get, :delete and :put. By default it will be :post.

  • :disabled - If set to true, it will generate a disabled button.

  • :confirm - This will use the unobtrusive JavaScript driver to prompt with the question specified. If the user accepts, the link is processed normally, otherwise no action is taken.

  • :remote - If set to true, will allow the Unobtrusive JavaScript drivers to control the submit behaviour. By default this behaviour is an ajax submit.

Examples

  <%= button_to "New", :action => "new" %>
  # => "<form method="post" action="/controller/new" class="button_to">
  #      <div><input value="New" type="submit" /></div>
  #    </form>"

  <%= button_to "Delete Image", { :action => "delete", :id => @image.id },
            :confirm => "Are you sure?", :method => :delete %>
  # => "<form method="post" action="/images/delete/1" class="button_to">
  #      <div>
  #        <input type="hidden" name="_method" value="delete" />
  #        <input data-confirm='Are you sure?' value="Delete" type="submit" />
  #      </div>
  #    </form>"

  <%= button_to('Destroy', 'http://www.example.com', :confirm => 'Are you sure?',
            :method => "delete", :remote => true, :disable_with => 'loading...') %>
  # => "<form class='button_to' method='post' action='http://www.example.com' data-remote='true'>
  #       <div>
  #         <input name='_method' value='delete' type='hidden' />
  #         <input value='Destroy' type='submit' disable_with='loading...' data-confirm='Are you sure?' />
  #       </div>
  #     </form>"
  #
     # File lib/action_view/helpers/url_helper.rb, line 302
302:       def button_to(name, options = {}, html_options = {})
303:         html_options = html_options.stringify_keys
304:         convert_boolean_attributes!(html_options, %( disabled ))
305: 
306:         method_tag = ''
307:         if (method = html_options.delete('method')) && %{put delete}.include?(method.to_s)
308:           method_tag = tag('input', :type => 'hidden', :name => '_method', :value => method.to_s)
309:         end
310: 
311:         form_method = method.to_s == 'get' ? 'get' : 'post'
312: 
313:         remote = html_options.delete('remote')
314: 
315:         request_token_tag = ''
316:         if form_method == 'post' && protect_against_forgery?
317:           request_token_tag = tag(:input, :type => "hidden", :name => request_forgery_protection_token.to_s, :value => form_authenticity_token)
318:         end
319: 
320:         url = options.is_a?(String) ? options : self.url_for(options)
321:         name ||= url
322: 
323:         html_options = convert_options_to_data_attributes(options, html_options)
324: 
325:         html_options.merge!("type" => "submit", "value" => name)
326: 
327:         ("<form method=\"#{form_method}\" action=\"#{html_escape(url)}\" #{"data-remote=\"true\"" if remote} class=\"button_to\"><div>" +
328:           method_tag + tag("input", html_options) + request_token_tag + "</div></form>").html_safe
329:       end
current_page?(options) click to toggle source

True if the current request URI was generated by the given options.

Examples

Let’s say we’re in the /shop/checkout?order=desc action.

  current_page?(:action => 'process')
  # => false

  current_page?(:controller => 'shop', :action => 'checkout')
  # => true

  current_page?(:controller => 'shop', :action => 'checkout', :order => 'asc')
  # => false

  current_page?(:action => 'checkout')
  # => true

  current_page?(:controller => 'library', :action => 'checkout')
  # => false

Let’s say we’re in the /shop/checkout?order=desc&page=1 action.

  current_page?(:action => 'process')
  # => false

  current_page?(:controller => 'shop', :action => 'checkout')
  # => true

  current_page?(:controller => 'shop', :action => 'checkout', :order => 'desc', :page=>'1')
  # => true

  current_page?(:controller => 'shop', :action => 'checkout', :order => 'desc', :page=>'2')
  # => false

  current_page?(:controller => 'shop', :action => 'checkout', :order => 'desc')
  # => false

  current_page?(:action => 'checkout')
  # => true

  current_page?(:controller => 'library', :action => 'checkout')
  # => false
     # File lib/action_view/helpers/url_helper.rb, line 558
558:       def current_page?(options)
559:         unless request
560:           raise "You cannot use helpers that need to determine the current "                  "page unless your view context provides a Request object "                  "in a #request method"
561:         end
562: 
563:         url_string = url_for(options)
564: 
565:         # We ignore any extra parameters in the request_uri if the
566:         # submitted url doesn't have any either.  This lets the function
567:         # work with things like ?order=asc
568:         if url_string.index("?")
569:           request_uri = request.fullpath
570:         else
571:           request_uri = request.path
572:         end
573: 
574:         if url_string =~ /^\w+:\/\//
575:           url_string == "#{request.protocol}#{request.host_with_port}#{request_uri}"
576:         else
577:           url_string == request_uri
578:         end
579:       end
mail_to(email_address, name = nil, html_options = {}) click to toggle source

Creates a mailto link tag to the specified email_address, which is also used as the name of the link unless name is specified. Additional HTML attributes for the link can be passed in html_options.

mail_to has several methods for hindering email harvesters and customizing the email itself by passing special keys to html_options.

Options

  • :encode - This key will accept the strings “javascript” or “hex”. Passing “javascript” will dynamically create and encode the mailto link then eval it into the DOM of the page. This method will not show the link on the page if the user has JavaScript disabled. Passing “hex” will hex encode the email_address before outputting the mailto link.

  • :replace_at - When the link name isn’t provided, the email_address is used for the link label. You can use this option to obfuscate the email_address by substituting the @ sign with the string given as the value.

  • :replace_dot - When the link name isn’t provided, the email_address is used for the link label. You can use this option to obfuscate the email_address by substituting the . in the email with the string given as the value.

  • :subject - Preset the subject line of the email.

  • :body - Preset the body of the email.

  • :cc - Carbon Copy addition recipients on the email.

  • :bcc - Blind Carbon Copy additional recipients on the email.

Examples

  mail_to "me@domain.com"
  # => <a href="mailto:me@domain.com">me@domain.com</a>

  mail_to "me@domain.com", "My email", :encode => "javascript"
  # => <script type="text/javascript">eval(decodeURIComponent('%64%6f%63...%27%29%3b'))</script>

  mail_to "me@domain.com", "My email", :encode => "hex"
  # => <a href="mailto:%6d%65@%64%6f%6d%61%69%6e.%63%6f%6d">My email</a>

  mail_to "me@domain.com", nil, :replace_at => "_at_", :replace_dot => "_dot_", :class => "email"
  # => <a href="mailto:me@domain.com" class="email">me_at_domain_dot_com</a>

  mail_to "me@domain.com", "My email", :cc => "ccaddress@domain.com",
           :subject => "This is an example email"
  # => <a href="mailto:me@domain.com?cc=ccaddress@domain.com&subject=This%20is%20an%20example%20email">My email</a>
     # File lib/action_view/helpers/url_helper.rb, line 472
472:       def mail_to(email_address, name = nil, html_options = {})
473:         email_address = html_escape(email_address)
474: 
475:         html_options = html_options.stringify_keys
476:         encode = html_options.delete("encode").to_s
477:         cc, bcc, subject, body = html_options.delete("cc"), html_options.delete("bcc"), html_options.delete("subject"), html_options.delete("body")
478: 
479:         extras = []
480:         extras << "cc=#{Rack::Utils.escape(cc).gsub("+", "%20")}" unless cc.nil?
481:         extras << "bcc=#{Rack::Utils.escape(bcc).gsub("+", "%20")}" unless bcc.nil?
482:         extras << "body=#{Rack::Utils.escape(body).gsub("+", "%20")}" unless body.nil?
483:         extras << "subject=#{Rack::Utils.escape(subject).gsub("+", "%20")}" unless subject.nil?
484:         extras = extras.empty? ? '' : '?' + html_escape(extras.join('&'))
485: 
486:         email_address_obfuscated = email_address.dup
487:         email_address_obfuscated.gsub!(/@/, html_options.delete("replace_at")) if html_options.has_key?("replace_at")
488:         email_address_obfuscated.gsub!(/\./, html_options.delete("replace_dot")) if html_options.has_key?("replace_dot")
489: 
490:         string = ''
491: 
492:         if encode == "javascript"
493:           "document.write('#{content_tag("a", name || email_address_obfuscated.html_safe, html_options.merge("href" => "mailto:#{email_address}#{extras}".html_safe))}');".each_byte do |c|
494:             string << sprintf("%%%x", c)
495:           end
496:           "<script type=\"#{Mime::JS}\">eval(decodeURIComponent('#{string}'))</script>".html_safe
497:         elsif encode == "hex"
498:           email_address_encoded = ''
499:           email_address_obfuscated.each_byte do |c|
500:             email_address_encoded << sprintf("&#%d;", c)
501:           end
502: 
503:           protocol = 'mailto:'
504:           protocol.each_byte { |c| string << sprintf("&#%d;", c) }
505: 
506:           email_address.each_byte do |c|
507:             char = c.chr
508:             string << (char =~ /\w/ ? sprintf("%%%x", c) : char)
509:           end
510:           content_tag "a", name || email_address_encoded.html_safe, html_options.merge("href" => "#{string}#{extras}".html_safe)
511:         else
512:           content_tag "a", name || email_address_obfuscated.html_safe, html_options.merge("href" => "mailto:#{email_address}#{extras}".html_safe)
513:         end
514:       end
url_for(options = {}) click to toggle source

Returns the URL for the set of options provided. This takes the same options as url_for in Action Controller (see the documentation for ActionController::Base#url_for). Note that by default :only_path is true so you’ll get the relative “/controller/action“ instead of the fully qualified URL like “example.com/controller/action“.

Options

  • :anchor - Specifies the anchor name to be appended to the path.

  • :only_path - If true, returns the relative URL (omitting the protocol, host name, and port) (true by default unless :host is specified).

  • :trailing_slash - If true, adds a trailing slash, as in “/archive/2005/“. Note that this is currently not recommended since it breaks caching.

  • :host - Overrides the default (current) host if provided.

  • :protocol - Overrides the default (current) protocol if provided.

  • :user - Inline HTTP authentication (only plucked out if :password is also present).

  • :password - Inline HTTP authentication (only plucked out if :user is also present).

Relying on named routes

If you instead of a hash pass a record (like an Active Record or Active Resource) as the options parameter, you’ll trigger the named route for that record. The lookup will happen on the name of the class. So passing a Workshop object will attempt to use the workshop_path route. If you have a nested route, such as admin_workshop_path you’ll have to call that explicitly (it’s impossible for url_for to guess that route).

Examples

  <%= url_for(:action => 'index') %>
  # => /blog/

  <%= url_for(:action => 'find', :controller => 'books') %>
  # => /books/find

  <%= url_for(:action => 'login', :controller => 'members', :only_path => false, :protocol => 'https') %>
  # => https://www.railsapplication.com/members/login/

  <%= url_for(:action => 'play', :anchor => 'player') %>
  # => /messages/play/#player

  <%= url_for(:action => 'jump', :anchor => 'tax&ship') %>
  # => /testing/jump/#tax&ship

  <%= url_for(Workshop.new) %>
  # relies on Workshop answering a persisted? call (and in this case returning false)
  # => /workshops

  <%= url_for(@workshop) %>
  # calls @workshop.to_s
  # => /workshops/5

  <%= url_for("http://www.example.com") %>
  # => http://www.example.com

  <%= url_for(:back) %>
  # if request.env["HTTP_REFERER"] is set to "http://www.example.com"
  # => http://www.example.com

  <%= url_for(:back) %>
  # if request.env["HTTP_REFERER"] is not set or is blank
  # => javascript:history.back()
     # File lib/action_view/helpers/url_helper.rb, line 92
 92:       def url_for(options = {})
 93:         options ||= {}
 94:         url = case options
 95:         when String
 96:           options
 97:         when Hash
 98:           options = options.symbolize_keys.reverse_merge!(:only_path => options[:host].nil?)
 99:           super
100:         when :back
101:           controller.request.env["HTTP_REFERER"] || 'javascript:history.back()'
102:         else
103:           polymorphic_path(options)
104:         end
105: 
106:         url
107:       end
url_options() click to toggle source

Need to map default url options to controller one. def default_url_options(*args) #:nodoc:

  controller.send(:default_url_options, *args)

end

    # File lib/action_view/helpers/url_helper.rb, line 30
30:       def url_options
31:         return super unless controller.respond_to?(:url_options)
32:         controller.url_options
33:       end

Private Instance Methods

add_confirm_to_attributes!(html_options, confirm) click to toggle source
     # File lib/action_view/helpers/url_helper.rb, line 608
608:         def add_confirm_to_attributes!(html_options, confirm)
609:           html_options["data-confirm"] = confirm if confirm
610:         end
add_disable_with_to_attributes!(html_options, disable_with) click to toggle source
     # File lib/action_view/helpers/url_helper.rb, line 612
612:         def add_disable_with_to_attributes!(html_options, disable_with)
613:           html_options["data-disable-with"] = disable_with if disable_with
614:         end
add_method_to_attributes!(html_options, method) click to toggle source
     # File lib/action_view/helpers/url_helper.rb, line 616
616:         def add_method_to_attributes!(html_options, method)
617:           html_options["rel"] = "nofollow" if method && method.to_s.downcase != "get"
618:           html_options["data-method"] = method if method
619:         end
array_or_string_for_javascript(option) click to toggle source
     # File lib/action_view/helpers/url_helper.rb, line 629
629:         def array_or_string_for_javascript(option)
630:           if option.kind_of?(Array)
631:             "['#{option.join('\',\'')}']"
632:           elsif !option.nil?
633:             "'#{option}'"
634:           end
635:         end
convert_boolean_attributes!(html_options, bool_attrs) click to toggle source

Processes the html_options hash, converting the boolean attributes from true/false form into the form required by HTML/XHTML. (An attribute is considered to be boolean if its name is listed in the given bool_attrs array.)

More specifically, for each boolean attribute in html_options given as:

  "attr" => bool_value

if the associated bool_value evaluates to true, it is replaced with the attribute’s name; otherwise the attribute is removed from the html_options hash. (See the XHTML 1.0 spec, section 4.5 “Attribute Minimization” for more: www.w3.org/TR/xhtml1/#h-4.5)

Returns the updated html_options hash, which is also modified in place.

Example:

  convert_boolean_attributes!( html_options,
                               %w( checked disabled readonly ) )
     # File lib/action_view/helpers/url_helper.rb, line 660
660:         def convert_boolean_attributes!(html_options, bool_attrs)
661:           bool_attrs.each { |x| html_options[x] = x if html_options.delete(x) }
662:           html_options
663:         end
convert_options_to_data_attributes(options, html_options) click to toggle source
     # File lib/action_view/helpers/url_helper.rb, line 584
584:         def convert_options_to_data_attributes(options, html_options)
585:           html_options = {} if html_options.nil?
586:           html_options = html_options.stringify_keys
587: 
588:           if (options.is_a?(Hash) && options.key?('remote') && options.delete('remote')) || (html_options.is_a?(Hash) && html_options.key?('remote') && html_options.delete('remote'))
589:             html_options['data-remote'] = 'true'
590:           end
591: 
592:           disable_with = html_options.delete("disable_with")
593:           confirm = html_options.delete("confirm")
594: 
595:           if html_options.key?("popup")
596:             ActiveSupport::Deprecation.warn(":popup has been deprecated", caller)
597:           end
598: 
599:           method, href = html_options.delete("method"), html_options['href']
600: 
601:           add_disable_with_to_attributes!(html_options, disable_with) if disable_with
602:           add_confirm_to_attributes!(html_options, confirm) if confirm
603:           add_method_to_attributes!(html_options, method)   if method
604: 
605:           html_options
606:         end
options_for_javascript(options) click to toggle source
     # File lib/action_view/helpers/url_helper.rb, line 621
621:         def options_for_javascript(options)
622:           if options.empty?
623:             '{}'
624:           else
625:             "{#{options.keys.map { |k| "#{k}:#{options[k]}" }.sort.join(', ')}}"
626:           end
627:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.