Namespace
Methods
- A
- C
- F
- N
- U
- V
Constants
BROWSER_LIKE_ACCEPTS | = | /,\s*\*\/\*|\*\/\*\s*,/ |
RESCUABLE_MIME_FORMAT_ERRORS | = | [ ActionController::BadRequest, ActionDispatch::Http::Parameters::ParseError, ] |
Instance Public methods
accepts()
Link
Returns the accepted MIME type for the request.
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 44 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()
Link
The MIME type of the HTTP request, such as Mime.
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 22 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
content_type()
Link
format(view_path = [])
Link
Returns the MIME type for the format used in the request.
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
format=(extension)
Link
Sets the format by string extension, which can be used to force custom formats that are not controlled by the 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
formats()
Link
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 69 def formats fetch_header("action_dispatch.request.formats") do |k| params_readable = begin parameters[:format] rescue *RESCUABLE_MIME_FORMAT_ERRORS false end v = if params_readable Array(Mime[parameters[:format]]) elsif use_accept_header && valid_accept_header accepts elsif extension_format = format_from_path_extension [extension_format] elsif xhr? [Mime[:js]] else [Mime[:html]] end v = v.select do |format| format.symbol || format.ref == "*/*" end set_header k, v end end
formats=(extensions)
Link
Sets the formats by string extensions. This differs from format=
by allowing you to set multiple, ordered formats, which is useful when you want to have a fallback.
In this example, the :iphone format will be used if it's available, otherwise it'll fallback to the :html format.
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
negotiate_mime(order)
Link
Returns the first MIME type that matches the provided array of MIME types.
variant()
Link
variant=(variant)
Link
Sets the variant for template.
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 98 def variant=(variant) variant = Array(variant) if variant.all? { |v| v.is_a?(Symbol) } @variant = ActiveSupport::ArrayInquirer.new(variant) else raise ArgumentError, "request.variant must be set to a Symbol or an Array of Symbols." end end
Instance Private methods
format_from_path_extension()
Link
use_accept_header()
Link