常量
RENDERERS | = | Set.new |
包含与可用渲染器 proc 对应的渲染器名称的 Set。默认值为 |
类公共方法
_render_with_renderer_method_name(key) 链接
源代码:显示 | 在 GitHub 上
# File actionpack/lib/action_controller/metal/renderers.rb, line 90 def self._render_with_renderer_method_name(key) "_render_with_renderer_#{key}" end
add(key, &block) 链接
在控制器操作中添加一个新的渲染器。通过将渲染器的名称作为选项传递给 AbstractController::Rendering#render
来调用渲染器。要创建渲染器,请传递一个名称和一个代码块。代码块接受两个参数,第一个是与其键配对的值,第二个是传递给 render
的剩余选项哈希。
创建一个 csv 渲染器
ActionController::Renderers.add :csv do |obj, options|
filename = options[:filename] || 'data'
str = obj.respond_to?(:to_csv) ? obj.to_csv : obj.to_s
send_data str, type: Mime[:csv],
disposition: "attachment; filename=#{filename}.csv"
end
请注意,我们使用 Mime 作为 csv mime 类型,因为它随 Rails 一起提供。对于自定义渲染器,您需要使用 Mime::Type.register
注册 mime 类型。
在控制器操作中使用 csv 渲染器
def show
@csvable = Csvable.find(params[:id])
respond_to do |format|
format.html
format.csv { render csv: @csvable, filename: @csvable.name }
end
end
来源:显示 | 在 GitHub 上
# File actionpack/lib/action_controller/metal/renderers.rb, line 74 def self.add(key, &block) define_method(_render_with_renderer_method_name(key), &block) RENDERERS << key.to_sym end
remove(key) 链接
此方法与 add 方法相反。
要删除 csv 渲染器
ActionController::Renderers.remove(:csv)
来源:显示 | 在 GitHub 上
# File actionpack/lib/action_controller/metal/renderers.rb, line 84 def self.remove(key) RENDERERS.delete(key.to_sym) method_name = _render_with_renderer_method_name(key) remove_possible_method(method_name) end
实例公共方法
_render_to_body_with_renderer(options) 链接
来源:显示 | 在 GitHub 上
# File actionpack/lib/action_controller/metal/renderers.rb, line 144 def _render_to_body_with_renderer(options) _renderers.each do |name| if options.key?(name) _process_options(options) method_name = Renderers._render_with_renderer_method_name(name) return send(method_name, options.delete(name), options) end end nil end
render_to_body(options) 链接
由 AbstractController::Rendering
中的 render
调用,该方法将返回值设置为 response_body
。
如果找不到渲染器,super
会将控制权返回给 ActionView::Rendering.render_to_body
(如果存在)。
来源:显示 | 在 GitHub 上
# File actionpack/lib/action_controller/metal/renderers.rb, line 140 def render_to_body(options) _render_to_body_with_renderer(options) || super end