Class/Module Index [+]

Quicksearch

Sinatra::UrlForHelper

Public Instance Methods

api_url_for(url_fragment, mode=:path_only) click to toggle source
# File lib/sinatra/url_for.rb, line 32
def api_url_for(url_fragment, mode=:path_only)
  matrix_params = ''
  if request.params['api']
    matrix_params += ";provider=%s" % request.params['api']['provider'] if request.params['api']['provider']
    matrix_params += ";driver=%s" % request.params['api']['driver'] if request.params['api']['driver']
  end
  url_fragment = "/#{url_fragment}" unless url_fragment =~ /^\// # There is no need to prefix URI with '/'
  url_for "#{settings.root_url}#{matrix_params}#{url_fragment}", mode
end
url_for(url_fragment, mode=:path_only) click to toggle source

Construct a link to url_fragment, which should be given relative to the base of this Sinatra app. The mode should be either :path_only, which will generate an absolute path within the current domain (the default), or :full, which will include the site name and port number. (The latter is typically necessary for links in RSS feeds.) Example usage:

url_for "/"            # Returns "/myapp/"
url_for "/foo"         # Returns "/myapp/foo"
url_for "/foo", :full  # Returns "http://example.com/myapp/foo"
# File lib/sinatra/url_for.rb, line 55
def url_for url_fragment, mode=:path_only
  case mode
  when :path_only
    base = request.script_name
  when :full
    scheme = request.scheme
    port = request.port
    request_host = request.host
    if request.env['HTTP_X_FORWARDED_FOR']
      scheme = request.env['HTTP_X_FORWARDED_SCHEME'] || scheme
      port = request.env['HTTP_X_FORWARDED_PORT']
      request_host = request.env['HTTP_X_FORWARDED_HOST']
    end
    if (port.nil? || port == "" ||
        (scheme == 'http' && port.to_s == '80') ||
        (scheme == 'https' && port.to_s == '443'))
      port = ""
    else
      port = ":#{port}"
    end
    base = "#{scheme}://#{request_host}#{port}#{request.script_name}"
  else
    raise TypeError, "Unknown url_for mode #{mode}"
  end
  url_escape = URI.escape(url_fragment)
  # Don't add the base fragment if url_for gets called more than once
  # per url or the url_fragment passed in is an absolute url
  if url_escape.match(/^#{base}/) or url_escape.match(/^http/)
    url_escape
  else
    "#{base}#{url_escape}"
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.