跳至内容 跳至搜索
命名空间
方法
A
C
F
N
S
V

常量

BROWSER_LIKE_ACCEPTS = /,\s*\*\/\*|\*\/\*\s*,/
 

除非在列表中包含 /，否则我们使用正常的 内容协商，在这种情况下，我们假设您是浏览器并发送 HTML。
RESCUABLE_MIME_FORMAT_ERRORS = [ ActionController::BadRequest, ActionDispatch::Http::Parameters::ParseError, ]
 

实例公共方法

accepts()

返回请求的接受 MIME 类型。

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 42
def accepts
  fetch_header("action_dispatch.request.accepts") do |k|
    header = get_header("HTTP_ACCEPT").to_s.strip

    v = if header.empty?
      [content_mime_type]
    else
      Mime::Type.parse(header)
    end
    set_header k, v
  rescue ::Mime::Type::InvalidMimeType => e
    raise InvalidType, e.message
  end
end

content_mime_type()

HTTP 请求的 MIME 类型，例如 Mime。

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 24
def content_mime_type
  fetch_header("action_dispatch.request.content_type") do |k|
    v = if get_header("CONTENT_TYPE") =~ /^([^,;]*)/
      Mime::Type.lookup($1.strip.downcase)
    else
      nil
    end
    set_header k, v
  rescue ::Mime::Type::InvalidMimeType => e
    raise InvalidType, e.message
  end
end

format(_view_path = nil)

返回请求中使用的格式的 MIME 类型。

GET /posts/5.xml   | request.format => Mime[:xml]
GET /posts/5.xhtml | request.format => Mime[:html]
GET /posts/5       | request.format => Mime[:html] or Mime[:js], or request.accepts.first

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 63
def format(_view_path = nil)
  formats.first || Mime::NullType.instance
end

format=(extension)

通过字符串扩展名设置格式，这可以用来强制自定义格式，这些格式不受扩展名的控制。

class ApplicationController < ActionController::Base
  before_action :adjust_format_for_iphone

  private
    def adjust_format_for_iphone
      request.format = :iphone if request.env["HTTP_USER_AGENT"][/iPhone/]
    end
end

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 115
def format=(extension)
  parameters[:format] = extension.to_s
  set_header "action_dispatch.request.formats", [Mime::Type.lookup_by_extension(parameters[:format])]
end

formats()

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 67
def formats
  fetch_header("action_dispatch.request.formats") do |k|
    v = if params_readable?
      Array(Mime[parameters[:format]])
    elsif use_accept_header && valid_accept_header
      accepts.dup
    elsif extension_format = format_from_path_extension
      [extension_format]
    elsif xhr?
      [Mime[:js]]
    else
      [Mime[:html]]
    end

    v.select! do |format|
      format.symbol || format.ref == "*/*"
    end

    set_header k, v
  end
end

formats=(extensions)

通过字符串扩展名设置格式。这与 format= 不同，因为它允许您设置多个有序格式，这在您希望有回退时非常有用。

在这个例子中，如果 :iphone 格式可用，则将使用它，否则将回退到 :html 格式。

class ApplicationController < ActionController::Base
  before_action :adjust_format_for_iphone_with_html_fallback

  private
    def adjust_format_for_iphone_with_html_fallback
      request.formats = [ :iphone, :html ] if request.env["HTTP_USER_AGENT"][/iPhone/]
    end
end

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 135
def formats=(extensions)
  parameters[:format] = extensions.first.to_s
  set_header "action_dispatch.request.formats", extensions.collect { |extension|
    Mime::Type.lookup_by_extension(extension)
  }
end

negotiate_mime(order)

返回与提供的 MIME 类型数组匹配的第一个 MIME 类型。

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 143
def negotiate_mime(order)
  formats.each do |priority|
    if priority == Mime::ALL
      return order.first
    elsif order.include?(priority)
      return priority
    end
  end

  order.include?(Mime::ALL) ? format : nil
end

should_apply_vary_header?()

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 155
def should_apply_vary_header?
  !params_readable? && use_accept_header && valid_accept_header
end

variant()

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 100
def variant
  @variant ||= ActiveSupport::ArrayInquirer.new
end

variant=(variant)

设置模板的变体。

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 90
def variant=(variant)
  variant = Array(variant)

  if variant.all?(Symbol)
    @variant = ActiveSupport::ArrayInquirer.new(variant)
  else
    raise ArgumentError, "request.variant must be set to a Symbol or an Array of Symbols."
  end
end