Spec-Zone.ru › Ruby on Rails 8.1

модуль ActionController::Renderers

Константы

RENDERERS

Множество, содержащее имена рендереров, соответствующие доступным процедурам рендереров. Значения по умолчанию: :json, :js, :xml.

Методы класса общего доступа

add (key, &block) Показать исходный код
# File actionpack/lib/action_controller/metal/renderers.rb, line 88
def self.add(key, &block)
  define_method(_render_with_renderer_method_name(key), &block)
  RENDERERS << key.to_sym
end

Добавляет новый рендерер, вызываемый в действиях контроллера. Рендерер вызывается, если передать его имя в качестве параметра методу 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-тип с помощью Mime::Type.register.

Использование рендерера CSV в действии контроллера:

def show
  @csvable = Csvable.find(params[:id])
  respond_to do |format|
    format.html
    format.csv { render csv: @csvable, filename: @csvable.name }
  end
end
remove (key) Показать исходный код
# File actionpack/lib/action_controller/metal/renderers.rb, line 98
def self.remove(key)
  RENDERERS.delete(key.to_sym)
  method_name = _render_with_renderer_method_name(key)
  remove_possible_method(method_name)
end

Этот метод противоположен методу add.

Удаление рендерера CSV:

ActionController::Renderers.remove(:csv)

Методы экземпляра общего доступа

render_to_body (options) Показать исходный код
# File actionpack/lib/action_controller/metal/renderers.rb, line 154
def render_to_body(options)
  _render_to_body_with_renderer(options) || super
end

Вызывается методом render в AbstractController::Rendering, который устанавливает возвращаемое значение в качестве response_body.

Если рендерер не найден, super возвращает управление методу ActionView::Rendering.render_to_body, если он определён.

Вызывает метод суперкласса

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API