- A
- C
- F
- N
- U
- V
BROWSER_LIKE_ACCEPTS | = | /,\s*\*\/\*|\*\/\*\s*,/ |
[R] | variant |
Returns the accepted MIME type for the request.
The MIME type of the HTTP request, such as Mime::XML.
For backward compatibility, the post format is extracted from the X-Post-Data-Format HTTP header if present.
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
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
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 56 def formats @env["action_dispatch.request.formats"] ||= begin params_readable = begin parameters[:format] rescue ActionController::BadRequest false end if params_readable Array(Mime[parameters[:format]]) elsif use_accept_header && valid_accept_header accepts elsif xhr? [Mime::JS] else [Mime::HTML] end end end
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
Receives an array of mimes and return the first user sent mime that matches the order array.
Sets the variant for template.
# File actionpack/lib/action_dispatch/http/mime_negotiation.rb, line 77 def variant=(variant) if variant.is_a?(Symbol) @variant = [variant] elsif variant.nil? || variant.is_a?(Array) && variant.any? && variant.all?{ |v| v.is_a?(Symbol) } @variant = variant else raise ArgumentError, "request.variant must be set to a Symbol or an Array of Symbols, not a #{variant.class}. " "For security reasons, never directly set the variant to a user-provided value, " "like params[:variant].to_sym. Check user-provided value against a whitelist first, " "then set the variant: request.variant = :tablet if params[:variant] == 'tablet'" end end