edge badge
Methods
D
E
F
H
N
O
P
R
S
U
Constants
IP_HOST_REGEXP = /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/
 
HOST_REGEXP = /(^[^:]+:\/\/)?([^:]+)(?::(\d+$))?/
 
PROTOCOL_REGEXP = /^([^:]+)(:)?(\/\/)?$/
 
Class Public methods
new(env)
# File actionpack/lib/action_dispatch/http/url.rb, line 174
def initialize(env)
  super
  @protocol = nil
  @port     = nil
end
Instance Public methods
domain(tld_length = @@tld_length)

Returns the domain part of a host, such as “rubyonrails.org” in “www.rubyonrails.org”. You can specify a different tld_length, such as 2 to catch rubyonrails.co.uk in “www.rubyonrails.co.uk”.

# File actionpack/lib/action_dispatch/http/url.rb, line 252
def domain(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_domain(host, tld_length)
end
extract_domain(host, tld_length)
# File actionpack/lib/action_dispatch/http/url.rb, line 15
def extract_domain(host, tld_length)
  extract_domain_from(host, tld_length) if named_host?(host)
end
extract_subdomain(host, tld_length)
# File actionpack/lib/action_dispatch/http/url.rb, line 27
def extract_subdomain(host, tld_length)
  extract_subdomains(host, tld_length).join('.')
end
extract_subdomains(host, tld_length)
# File actionpack/lib/action_dispatch/http/url.rb, line 19
def extract_subdomains(host, tld_length)
  if named_host?(host)
    extract_subdomains_from(host, tld_length)
  else
    []
  end
end
full_url_for(options)
# File actionpack/lib/action_dispatch/http/url.rb, line 39
def full_url_for(options)
  host     = options[:host]
  protocol = options[:protocol]
  port     = options[:port]

  unless host
    raise ArgumentError, 'Missing host to link to! Please provide the :host parameter, set default_url_options[:host], or set :only_path to true'
  end

  build_host_url(host, port, protocol, options, path_for(options))
end
host()

Returns the host for this request, such as example.com.

# File actionpack/lib/action_dispatch/http/url.rb, line 200
def host
  raw_host_with_port.sub(/:\d+$/, '')
end
host_with_port()

Returns a host:port string for this request, such as “example.com” or “example.com:8080”.

# File actionpack/lib/action_dispatch/http/url.rb, line 206
def host_with_port
  "#{host}#{port_string}"
end
optional_port()

Returns a number port suffix like 8080 if the port number of this request is not the default HTTP port 80 or HTTPS port 443.

# File actionpack/lib/action_dispatch/http/url.rb, line 236
def optional_port
  standard_port? ? nil : port
end
path_for(options)
# File actionpack/lib/action_dispatch/http/url.rb, line 51
def path_for(options)
  result  = options[:script_name].to_s.chomp("/")
  result << options[:path].to_s

  result = add_trailing_slash(result) if options[:trailing_slash]

  result = add_params options, result
  add_anchor options, result
end
port()

Returns the port number of this request as an integer.

# File actionpack/lib/action_dispatch/http/url.rb, line 211
def port
  @port ||= begin
    if raw_host_with_port =~ /:(\d+)$/
      $1.to_i
    else
      standard_port
    end
  end
end
port_string()

Returns a string port suffix, including colon, like “:8080” if the port number of this request is not the default HTTP port 80 or HTTPS port 443.

# File actionpack/lib/action_dispatch/http/url.rb, line 242
def port_string
  standard_port? ? '' : ":#{port}"
end
protocol()

Returns 'https://' if this is an SSL request and 'http://' otherwise.

# File actionpack/lib/action_dispatch/http/url.rb, line 186
def protocol
  @protocol ||= ssl? ? 'https://' : 'http://'
end
raw_host_with_port()

Returns the host for this request, such as “example.com”.

# File actionpack/lib/action_dispatch/http/url.rb, line 191
def raw_host_with_port
  if forwarded = env["HTTP_X_FORWARDED_HOST"]
    forwarded.split(/,\s?/).last
  else
    env['HTTP_HOST'] || "#{env['SERVER_NAME'] || env['SERVER_ADDR']}:#{env['SERVER_PORT']}"
  end
end
server_port()
# File actionpack/lib/action_dispatch/http/url.rb, line 246
def server_port
  @env['SERVER_PORT'].to_i
end
standard_port()

Returns the standard port number for this request's protocol.

# File actionpack/lib/action_dispatch/http/url.rb, line 222
def standard_port
  case protocol
    when 'https://' then 443
    else 80
  end
end
standard_port?()

Returns whether this request is using the standard port

# File actionpack/lib/action_dispatch/http/url.rb, line 230
def standard_port?
  port == standard_port
end
subdomain(tld_length = @@tld_length)

Returns all the subdomains as a string, so "dev.www" would be returned for “dev.www.rubyonrails.org”. You can specify a different tld_length, such as 2 to catch "www" instead of "www.rubyonrails" in “www.rubyonrails.co.uk”.

# File actionpack/lib/action_dispatch/http/url.rb, line 268
def subdomain(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_subdomain(host, tld_length)
end
subdomains(tld_length = @@tld_length)

Returns all the subdomains as an array, so ["dev", "www"] would be returned for “dev.www.rubyonrails.org”. You can specify a different tld_length, such as 2 to catch ["www"] instead of ["www", "rubyonrails"] in “www.rubyonrails.co.uk”.

# File actionpack/lib/action_dispatch/http/url.rb, line 260
def subdomains(tld_length = @@tld_length)
  ActionDispatch::Http::URL.extract_subdomains(host, tld_length)
end
url()

Returns the complete URL used for this request.

# File actionpack/lib/action_dispatch/http/url.rb, line 181
def url
  protocol + host_with_port + fullpath
end
url_for(options)
# File actionpack/lib/action_dispatch/http/url.rb, line 31
def url_for(options)
  if options[:only_path]
    path_for options
  else
    full_url_for options
  end
end