Changeset 6674

Timestamp:

05/06/07 04:29:42 (2 years ago)

Author:

marcel

Message:

Enhance documentation and add examples for url_for. Closes #8227. [jeremymcanally]

Files:

• trunk/actionpack/CHANGELOG (modified) (1 diff)
• trunk/actionpack/lib/action_view/helpers/url_helper.rb (modified) (13 diffs)

trunk/actionpack/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* Enhance documentation and add examples for url_for. [jeremymcanally]
-
-* Fix documentation typo in routes. [norbert, pam]

trunk/actionpack/lib/action_view/helpers/url_helper.rb

@@ -3 +3 @@
-module ActionView
-  module Helpers #:nodoc:
-
-
-
+
+
+
+
-    module UrlHelper
-      include JavaScriptHelper
-
-      # Returns the URL for the set of +options+ provided. This takes the
-action controller. For a list, 
-. Note that it'll
-set :only_path => true
-
+ActionController (
+). Note that by default
+<tt>:only_path</tt> is <tt>true</tt>
+URL like 
-      #
-      # When called from a view, url_for returns an HTML escaped url. If you
-      # need an unescaped url, pass :escape => false in the +options+.
+      #
+      # ==== Options
+      # * <tt>:anchor</tt> -- specifies the anchor name to be appended to the path.
+      # * <tt>:only_path</tt> --  if true, returns the relative URL (omitting the protocol, host name, and port) (<tt>true</tt> by default)
+      # * <tt>:trailing_slash</tt> --  if true, adds a trailing slash, as in "/archive/2005/". Note that this
+      #   is currently not recommended since it breaks caching.
+      # * <tt>:host</tt> -- overrides the default (current) host if provided
+      # * <tt>:protocol</tt> -- overrides the default (current) protocol if provided
+      # * <tt>:user</tt> -- Inline HTTP authentication (only plucked out if :password is also present)
+      # * <tt>:password</tt> -- Inline HTTP authentication (only plucked out if :user is also present)
+      # * <tt>:escape</tt> -- Determines whether the returned URL will be HTML escaped or not (<tt>true</tt> by default)
+      #
+      # ==== 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 => 'checkout', :anchor => 'tax&ship') %>
+      #   # => /testing/jump/#tax&amp;ship
+      #
+      #   <%= url_for(:action => 'checkout', :anchor => 'tax&ship', :escape => false) %>
+      #   # => /testing/jump/#tax&ship
-      def url_for(options = {}, *parameters_for_method_reference)
-        if options.kind_of? Hash
@@ -31 +62 @@
-      # Creates a link tag of the given +name+ using a URL created by the set
-      # of +options+. See the valid options in the documentation for
-ActionController::Base#
+
-      # of an options hash to get a link tag that uses the value of the string as the
-      # href for the link. If nil is passed as a name, the link itself will become
-      # the name.
-      #
-
-
-
-
+
+
-      #   prompt with the question specified. If the user accepts, the link is
-      #   processed normally, otherwise no action is taken.
-:
+ --
-      #   link to open in a popup window. By passing true, a default browser window
-      #   will be opened with the URL. You can also specify an array of options
-      #   that are passed-thru to JavaScripts window.open method.
-:
+ --
-      #   create an HTML form and immediately submit the form for processing using
-      #   the HTTP verb specified. Useful for having links perform a POST operation
@@ -55 +84 @@
-      #   for it in your controllers action by using the request objects methods
-      #   for post?, delete? or put?.
+      # * The +html_options+ will accept a hash of html attributes for the link tag.
-      #
-      # You can mix and match the +html_options+ with the exception of
@@ -60 +90 @@
-      # exception.
-      #
+      # ==== Examples
-      #   link_to "Visit Other Site", "http://www.rubyonrails.org/", :confirm => "Are you sure?"
+      #   # => <a href="http://www.rubyonrails.org/" onclick="return confirm('Are you sure?');">Visit Other Site</a>
+      #
-      #   link_to "Help", { :action => "help" }, :popup => true
+      #   # => <a href="/testing/help/" onclick="window.open(this.href);return false;">Help</a>
+      #
-      #   link_to "View Image", { :action => "view" }, :popup => ['new_window_name', 'height=300,width=600']
+      #   # => <a href="/testing/view/" onclick="window.open(this.href,'new_window_name','height=300,width=600');return false;">View Image</a>
+      #
-      #   link_to "Delete Image", { :action => "delete", :id => @image.id }, :confirm => "Are you sure?", :method => :delete
+      #   # => <a href="/testing/delete/9/" onclick="if (confirm('Are you sure?')) { var f = document.createElement('form'); 
+      #        f.style.display = 'none'; this.parentNode.appendChild(f); f.method = 'POST'; f.action = this.href;
+      #        var m = document.createElement('input'); m.setAttribute('type', 'hidden'); m.setAttribute('name', '_method'); 
+      #        m.setAttribute('value', 'delete'); f.appendChild(m);f.submit(); };return false;">Delete Image</a>
-      def link_to(name, options = {}, html_options = nil, *parameters_for_method_reference)
-        if html_options
@@ -91 +132 @@
-      # is given, it will default to performing a POST operation. You can also
-      # disable the button by passing <tt>:disabled => true</tt> in +html_options+.
-      #
-      #   button_to "New", :action => "new"
-      #
-      # Generates the following HTML:
-      #
-      #   <form method="post" action="/controller/new" class="button-to">
-      #     <div><input value="New" type="submit" /></div>
-      #   </form>
-      #
-      # If you are using RESTful routes, you can pass the <tt>:method</tt>
-      # to change the HTTP verb used to submit the form.
-      #
+      # ==== Options
+      # The +options+ hash accepts the same options at url_for.
+      #
+      # There are a few special +html_options+:
+      # * <tt>:method</tt> -- specifies the anchor name to be appended to the path.
+      # * <tt>:disabled</tt> -- specifies the anchor name to be appended to the path.
+      # * <tt>:confirm</tt> -- This will add a JavaScript confirm
+      #   prompt with the question specified. If the user accepts, the link is
+      #   processed normally, otherwise no action is taken.
+      # 
+      # ==== 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
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-      def button_to(name, options = {}, html_options = {})
-        html_options = html_options.stringify_keys
@@ -141 +186 @@
-
-      # Creates a link tag of the given +name+ using a URL created by the set of
-uri
+URI
-      # which case only the name is returned (or the given block is yielded, if
-
+
+
+
+
+
+
-      #
-      #   <ul id="navbar">
@@ -150 +200 @@
-      #   </ul>
-      #
-This will render the following HTML when on the about us page:
+If in the "about" action, it will render...
-      #
-      #   <ul id="navbar">
@@ -156 +206 @@
-      #     <li>About Us</li>
-      #   </ul>
+      #
+      # ...but if in the "home" action, it will render:
+      #
+      #   <ul id="navbar">
+      #     <li><a href="/controller/index">Home</a></li>
+      #     <li><a href="/controller/about">About Us</a></li>
+      #   </ul>
+      #
+      # The implicit block given to link_to_unless_current is evaluated if the current
+      # action is the action given.  So, if we had a comments page and wanted to render a 
+      # "Go Back" link instead of a link to the comments page, we could do something like this...
+      #   
+      #    <%= 
+      #        link_to_unless_current("Comment", { :controller => 'comments', :action => 'new}) do
+      #           link_to("Go back", { :controller => 'posts', :action => 'index' }) 
+      #        end 
+      #     %>
-      def link_to_unless_current(name, options = {}, html_options = {}, *parameters_for_method_reference, &block)
-        link_to_unless current_page?(options), name, options, html_options, *parameters_for_method_reference, &block
@@ -162 +229 @@
-      # Creates a link tag of the given +name+ using a URL created by the set of
-      # +options+ unless +condition+ is true, in which case only the name is
-
-
-
+
+
+
+
+
-      #   <%= link_to_unless(@current_user.nil?, "Reply", { :action => "reply" }) %>
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-      def link_to_unless(condition, name, options = {}, html_options = {}, *parameters_for_method_reference, &block)
-        if condition
@@ -189 +264 @@
-      # accepts the name or the full argument list for link_to_unless (see the examples
-      # in link_to_unless).
+      #
+      # ==== Examples
+      #   <%= link_to_if(@current_user.nil?, "Login", { :controller => "sessions", :action => "new" }) %>
+      #   # If the user isn't logged in...
+      #   # => <a href="/sessions/new/">Login</a>
+      #
+      #   <%= 
+      #      link_to_if(@current_user.nil?, "Login", { :controller => "sessions", :action => "new" }) do
+      #        link_to(@current_user.login, { :controller => "accounts", :action => "show", :id => @current_user })
+      #      end 
+      #   %>
+      #   # If the user isn't logged in...
+      #   # => <a href="/sessions/new/">Login</a>
+      #   # If they are logged in...
+      #   # => <a href="/accounts/show/3">my_username</a>
-      def link_to_if(condition, name, options = {}, html_options = {}, *parameters_for_method_reference, &block)
-        link_to_unless !condition, name, options, html_options, *parameters_for_method_reference, &block
@@ -195 +285 @@
-      # 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
+HTML
-      #
-      # mail_to has several methods for hindering email harvestors and customizing
-      # the email itself by passing special keys to +html_options+.
-      #
-
-
+
-      # * <tt>:encode</tt>  - This key will accept the strings "javascript" or "hex".
-      #   Passing "javascript" will dynamically create and encode the mailto: link then
@@ -220 +309 @@
-      # * <tt>:bcc</tt>  - Blind Carbon Copy additional recipients on the email.
-      #
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-      #
-      #   mail_to "me@domain.com", "My email", :cc => "ccaddress@domain.com",
-# =>
- 
+
+# =>
-      def mail_to(email_address, name = nil, html_options = {})
-        html_options = html_options.stringify_keys
@@ -281 +372 @@
-      end
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      def current_page?(options)
-        url_string = CGI.escapeHTML(url_for(options))