$_view
$_view : \Horde_View
The parent view invoking the helper.
View helpers for URLs
All helpers hold a link back to the instance of the view. The undefined property handlers (get()/call() methods) are used to mix helpers together, effectively placing them on the same pane of glass (the view) and allowing any helper to call any other.
$_view : \Horde_View
The parent view invoking the helper.
__construct(\Horde_View $view)
Creates a helper for $view.
| \Horde_View | $view | The view to help. |
urlFor( $first = array(), $second = array()) : string
Returns the URL for the set of +options+ provided. This takes the same options as url_for in ActionController (see the documentation for ActionController::Base#url_for). Note that by default <tt>:only_path</tt> is <tt>true</tt> so you'll get the relative /controller/action instead of the fully qualified URL like http://example.com/controller/action.
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
==== 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') %>
<%= url_for(:action => 'find', :controller => 'books') %>
<%= url_for(:action => 'login', :controller => 'members', :only_path => false, :protocol => 'https') %>
<%= url_for(:action => 'play', :anchor => 'player') %>
<%= url_for(:action => 'checkout', :anchor => 'tax&ship') %>
<%= url_for(:action => 'checkout', :anchor => 'tax&ship', :escape => false) %>
<%= url_for(Workshop.new) %>
<%= url_for(@workshop) %>
| $first | ||
| $second |
linkTo( $name, $options = array(), $htmlOptions = array())
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 url_for. It's also possible to pass a string instead of an options hash to get a link tag that uses the value of the string as the href for the link, or use +:back+ to link to the referrer - a JavaScript back link will be used in place of a referrer if none exists. If nil is passed as a name, the link itself will become the name.
==== Options
Note that if the user has JavaScript disabled, the request will fall back to using GET. If :href=>'#' is used and the user has JavaScript disabled clicking the link will have no effect. If you are relying on the POST behavior, your should check for it in your controller's action by using the request object's methods for post?, delete? or put?.
You can mix and match the +html_options+ with the exception of :popup and :method which will raise an ActionView::ActionViewError exception.
==== Examples link_to "Visit Other Site", "http://www.rubyonrails.org/", :confirm => "Are you sure?"
link_to "Help", { :action => "help" }, :popup => true
link_to "View Image", { :action => "view" }, :popup => ['new_window_name', 'height=300,width=600']
link_to "Delete Image", { :action => "delete", :id => @image.id }, :confirm => "Are you sure?", :method => :delete
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>| $name | ||
| $options | ||
| $htmlOptions |
linkToUnlessCurrent( $name, $url, $htmlOptions = array())
Creates a link tag of the given +name+ using a URL created by the set of +options+ unless the current request URI is the same as the links, in which case only the name is returned (or the given block is yielded, if one exists). You can give link_to_unless_current a block which will specialize the default behavior (e.g., show a "Start Here" link rather than the link's text).
==== Examples Let's say you have a navigation menu...
If in the "about" action, it will render...
...but if in the "home" action, it will render:
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 %>
| $name | ||
| $url | ||
| $htmlOptions |
linkToUnless( $condition, $name, $url, $htmlOptions = array())
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 returned. To specialize the default behavior (i.e., show a login link rather than just the plaintext link text), you can pass a block that accepts the name or the full argument list for link_to_unless.
==== Examples <%= link_to_unless(@current_user.nil?, "Reply", { :action => "reply" }) %>
<%= link_to_unless(@current_user.nil?, "Reply", { :action => "reply" }) do |name| link_to(name, { :controller => "accounts", :action => "signup" }) end %>
| $condition | ||
| $name | ||
| $url | ||
| $htmlOptions |
linkToIf( $condition, $name, $url, $htmlOptions = array())
Creates a link tag of the given +name+ using a URL created by the set of +options+ if +condition+ is true, in which case only the name is returned. To specialize the default behavior, you can pass a block that 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" }) %>
<%= 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 %>
| $condition | ||
| $name | ||
| $url | ||
| $htmlOptions |
mailTo( $emailAddress, $name = null, $htmlOptions = array())
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 harvestors and customizing the email itself by passing special keys to +html_options+.
==== Options
==== Examples mailTo("me@domain.com")
mailTo("me@domain.com", "My email", array('encode' => "javascript"))
mailTo("me@domain.com", "My email", array('encode' => "hex"))
mailTo("me@domain.com", null, array('replaceAt' => "at", 'replaceDot' => "dot", 'class' => "email"))
mailTo("me@domain.com", "My email", array('cc' => "ccaddress@domain.com", 'subject' => "This is an example email"))
| $emailAddress | ||
| $name | ||
| $htmlOptions |
isCurrentPage( $options)
True if the current request URI was generated by the given +options+.
==== Examples Let's say we're in the /shop/checkout action.
current_page?(:action => 'process')
current_page?(:controller => 'shop', :action => 'checkout')
current_page?(:action => 'checkout')
current_page?(:controller => 'library', :action => 'checkout')
| $options |