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

_routes_context() click to toggle source
    # File lib/action_view/helpers/url_helper.rb, line 26
26:       def _routes_context
27:         controller
28:       end
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.

By default, the generated form element has a class name of button_to to allow styling of the form itself and its children. This can be changed using the :form_class modifier within html_options. 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 behavior. By default this behavior is an ajax submit.

  • :form - This hash will be form attributes

  • :form_class - This controls the class of the form within which the submit button will be placed

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 "New", :action => "new", :form_class => "new-thing" %>
  # => "<form method="post" action="/controller/new" class="new-thing">
  #      <div><input value="New" type="submit" /></div>
  #    </form>"

  <%= button_to "Create", :action => "create", :remote => true, :form => { "data-type" => "json" } %>
  # => "<form method="post" action="/images/create" class="button_to" data-remote="true" data-type="json">
  #      <div><input value="Create" 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' data-disable-with='loading...' data-confirm='Are you sure?' />
  #       </div>
  #     </form>"
  #
     # File lib/action_view/helpers/url_helper.rb, line 324
324:       def button_to(name, options = {}, html_options = {})
325:         html_options = html_options.stringify_keys
326:         convert_boolean_attributes!(html_options, %( disabled ))
327: 
328:         method_tag = ''
329:         if (method = html_options.delete('method')) && %{put delete}.include?(method.to_s)
330:           method_tag = tag('input', :type => 'hidden', :name => '_method', :value => method.to_s)
331:         end
332: 
333:         form_method = method.to_s == 'get' ? 'get' : 'post'
334:         form_options = html_options.delete('form') || {}
335:         form_options[:class] ||= html_options.delete('form_class') || 'button_to'
336: 
337:         remote = html_options.delete('remote')
338: 
339:         request_token_tag = ''
340:         if form_method == 'post' && protect_against_forgery?
341:           request_token_tag = tag(:input, :type => "hidden", :name => request_forgery_protection_token.to_s, :value => form_authenticity_token)
342:         end
343: 
344:         url = options.is_a?(String) ? options : self.url_for(options)
345:         name ||= url
346: 
347:         html_options = convert_options_to_data_attributes(options, html_options)
348: 
349:         html_options.merge!("type" => "submit", "value" => name)
350: 
351:         form_options.merge!(:method => form_method, :action => url)
352:         form_options.merge!("data-remote" => "true") if remote
353: 
354:         "#{tag(:form, form_options, true)}<div>#{method_tag}#{tag("input", html_options)}#{request_token_tag}</div></form>".html_safe
355:       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

Let’s say we’re in the /products action with method POST in case of invalid product.

  current_page?(:controller => 'product', :action => 'index')
  # => false
     # File lib/action_view/helpers/url_helper.rb, line 588
588:       def current_page?(options)
589:         unless request
590:           raise "You cannot use helpers that need to determine the current "                  "page unless your view context provides a Request object "                  "in a #request method"
591:         end
592: 
593:         return false unless request.get?
594: 
595:         url_string = url_for(options)
596: 
597:         # We ignore any extra parameters in the request_uri if the
598:         # submitted url doesn't have any either. This lets the function
599:         # work with things like ?order=asc
600:         if url_string.index("?")
601:           request_uri = request.fullpath
602:         else
603:           request_uri = request.path
604:         end
605: 
606:         if url_string =~ /^\w+:\/\//
607:           url_string == "#{request.protocol}#{request.host_with_port}#{request_uri}"
608:         else
609:           url_string == request_uri
610:         end
611:       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 additional 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 498
498:       def mail_to(email_address, name = nil, html_options = {})
499:         email_address = ERB::Util.html_escape(email_address)
500: 
501:         html_options = html_options.stringify_keys
502:         encode = html_options.delete("encode").to_s
503: 
504:         extras = %{ cc bcc body subject }.map { |item|
505:           option = html_options.delete(item) || next
506:           "#{item}=#{Rack::Utils.escape(option).gsub("+", "%20")}"
507:         }.compact
508:         extras = extras.empty? ? '' : '?' + ERB::Util.html_escape(extras.join('&'))
509: 
510:         email_address_obfuscated = email_address.to_str
511:         email_address_obfuscated.gsub!(/@/, html_options.delete("replace_at")) if html_options.key?("replace_at")
512:         email_address_obfuscated.gsub!(/\./, html_options.delete("replace_dot")) if html_options.key?("replace_dot")
513:         case encode
514:         when "javascript"
515:           string = ''
516:           html   = content_tag("a", name || email_address_obfuscated.html_safe, html_options.merge("href" => "mailto:#{email_address}#{extras}".html_safe))
517:           html   = escape_javascript(html.to_str)
518:           "document.write('#{html}');".each_byte do |c|
519:             string << sprintf("%%%x", c)
520:           end
521:           "<script type=\"#{Mime::JS}\">eval(decodeURIComponent('#{string}'))</script>".html_safe
522:         when "hex"
523:           email_address_encoded = email_address_obfuscated.unpack('C*').map {|c|
524:             sprintf("&#%d;", c)
525:           }.join
526: 
527:           string = 'mailto:'.unpack('C*').map { |c|
528:             sprintf("&#%d;", c)
529:           }.join + email_address.unpack('C*').map { |c|
530:             char = c.chr
531:             char =~ /\w/ ? sprintf("%%%x", c) : char
532:           }.join
533: 
534:           content_tag "a", name || email_address_encoded.html_safe, html_options.merge("href" => "#{string}#{extras}".html_safe)
535:         else
536:           content_tag "a", name || email_address_obfuscated.html_safe, html_options.merge("href" => "mailto:#{email_address}#{extras}".html_safe)
537:         end
538:       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

Passing a record (like an Active Record or Active Resource) instead of a Hash as the options parameter will 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.example.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_param which by default returns the id
  # => /workshops/5

  # to_param can be re-defined in a model to provide different URL names:
  # => /workshops/1-workshop-name

  <%= 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 100
100:       def url_for(options = {})
101:         options ||= {}
102:         case options
103:         when String
104:           options
105:         when Hash
106:           options = options.symbolize_keys.reverse_merge!(:only_path => options[:host].nil?)
107:           super
108:         when :back
109:           controller.request.env["HTTP_REFERER"] || 'javascript:history.back()'
110:         else
111:           polymorphic_path(options)
112:         end
113:       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 35
35:       def url_options
36:         return super unless controller.respond_to?(:url_options)
37:         controller.url_options
38:       end

Private Instance Methods

add_method_to_attributes!(html_options, method) click to toggle source
     # File lib/action_view/helpers/url_helper.rb, line 649
649:         def add_method_to_attributes!(html_options, method)
650:           if method && method.to_s.downcase != "get" && html_options["rel"] !~ /nofollow/
651:             html_options["rel"] = "#{html_options["rel"]} nofollow".strip
652:           end
653:           html_options["data-method"] = method
654:         end
array_or_string_for_javascript(option) click to toggle source
     # File lib/action_view/helpers/url_helper.rb, line 664
664:         def array_or_string_for_javascript(option)
665:           if option.kind_of?(Array)
666:             "['#{option.join('\',\'')}']"
667:           elsif !option.nil?
668:             "'#{option}'"
669:           end
670:         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 695
695:         def convert_boolean_attributes!(html_options, bool_attrs)
696:           bool_attrs.each { |x| html_options[x] = x if html_options.delete(x) }
697:           html_options
698:         end
convert_options_to_data_attributes(options, html_options) click to toggle source
     # File lib/action_view/helpers/url_helper.rb, line 616
616:         def convert_options_to_data_attributes(options, html_options)
617:           if html_options
618:             html_options = html_options.stringify_keys
619:             html_options['data-remote'] = 'true' if link_to_remote_options?(options) || link_to_remote_options?(html_options)
620: 
621:             disable_with = html_options.delete("disable_with")
622:             confirm = html_options.delete('confirm')
623:             method  = html_options.delete('method')
624: 
625:             if disable_with
626:               ActiveSupport::Deprecation.warn ":disable_with option is deprecated and will be removed from Rails 4.0. Use 'data-disable-with' instead"
627: 
628:               html_options["data-disable-with"] = disable_with
629:             end
630: 
631:             if confirm
632:               ActiveSupport::Deprecation.warn ":confirm option is deprecated and will be removed from Rails 4.0. Use ':data => { :confirm => \'Text\' }' instead"
633: 
634:               html_options["data-confirm"] = confirm
635:             end
636: 
637:             add_method_to_attributes!(html_options, method) if method
638: 
639:             html_options
640:           else
641:             link_to_remote_options?(options) ? {'data-remote' => 'true'} : {}
642:           end
643:         end
options_for_javascript(options) click to toggle source
     # File lib/action_view/helpers/url_helper.rb, line 656
656:         def options_for_javascript(options)
657:           if options.empty?
658:             '{}'
659:           else
660:             "{#{options.keys.map { |k| "#{k}:#{options[k]}" }.sort.join(', ')}}"
661:           end
662:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.