Spec-Zone.ru › Ruby on Rails 8.1

class ActionController::Renderer

Родительский класс:
Object

Контроллер действий Renderer

ActionController::Renderer позволяет отображать произвольные шаблоны, не находясь внутри действия контроллера.

Получить экземпляр рендерера можно, вызвав renderer для класса контроллера:

ApplicationController.renderer
PostsController.renderer

а отобразить шаблон — вызвав метод render:

ApplicationController.renderer.render template: "posts/show", assigns: { post: Post.first }
PostsController.renderer.render :show, assigns: { post: Post.first }

Для удобства можно также вызвать render непосредственно для самого класса контроллера:

ApplicationController.render template: "posts/show", assigns: { post: Post.first }
PostsController.render :show, assigns: { post: Post.first }

Константы

DEFAULTS
RACK_KEY_TRANSLATION

Атрибуты

controller [R]

Публичные методы класса

for (controller, env = nil, defaults = DEFAULTS) Показать исходный код
# File actionpack/lib/action_controller/renderer.rb, line 64
def self.for(controller, env = nil, defaults = DEFAULTS)
  new(controller, env, defaults)
end

Создает новый рендерер с использованием указанного класса контроллера. См. ::new.

new (controller, env, defaults) Показать исходный код
# File actionpack/lib/action_controller/renderer.rb, line 110
def initialize(controller, env, defaults)
  @controller = controller
  @defaults = defaults
  if env.blank? && @defaults == DEFAULTS
    @env = DEFAULT_ENV
  else
    @env = normalize_env(@defaults)
    @env.merge!(normalize_env(env)) unless env.blank?
  end
end

Инициализирует новый Renderer.

Parameters

  • controller — класс контроллера, экземпляр которого создается для отображения.

  • env — окружение Rack, используемое для имитации запроса при отображении. Записи могут представлять собой обычные ключи и значения окружения Rack или быть любыми из перечисленных ниже; в этом случае они будут преобразованы соответствующим образом:

    • :http_host — HTTP-хост входящего запроса. Преобразуется в HTTP_HOST Rack.

    • :https — логическое значение, указывающее, использует ли входящий запрос HTTPS. Преобразуется в HTTPS Rack.

    • :method — HTTP-метод входящего запроса без учета регистра. Преобразуется в REQUEST_METHOD Rack.

    • :script_name — часть пути URL входящего запроса, соответствующая приложению. Преобразуется в SCRIPT_NAME Rack.

    • :input — поток ввода. Преобразуется в rack.input Rack.

  • defaults — значения по умолчанию для окружения Rack. Записи указываются в том же формате, что и env. env будут объединены с этими значениями с приоритетом. defaults будут сохранены при вызове new для экземпляра рендерера.

Если http_host не указано, HTTP-хост окружения будет получен из default_url_options маршрутов. В этом случае логическое значение https и script_name также будут получены из default_url_options, если они не указаны. Кроме того, для логического значения https будет использоваться значение Rails.application.config.force_ssl, если в default_url_options не указано значение protocol.

Публичные методы экземпляра

defaults () Показать исходный код
# File actionpack/lib/action_controller/renderer.rb, line 121
def defaults
  @defaults = @defaults.dup if @defaults.frozen?
  @defaults
end
new (env = nil) Показать исходный код
# File actionpack/lib/action_controller/renderer.rb, line 72
def new(env = nil)
  self.class.new controller, env, @defaults
end

Создает новый рендерер с тем же контроллером, но с новым окружением Rack.

ApplicationController.renderer.new(method: "post")
render (*args) Показать исходный код
# File actionpack/lib/action_controller/renderer.rb, line 128
def render(*args)
  request = ActionDispatch::Request.new(env_for_request)
  request.routes = controller._routes

  instance = controller.new
  instance.set_request! request
  instance.set_response! controller.make_response!(request)
  instance.render_to_string(*args)
end

Отображает шаблон в строку, как и ActionController::Rendering#render_to_string.

with_defaults (defaults) Показать исходный код
# File actionpack/lib/action_controller/renderer.rb, line 78
def with_defaults(defaults)
  self.class.new controller, @env, @defaults.merge(defaults)
end

Создает новый рендерер с тем же контроллером, объединяя указанные значения по умолчанию с предыдущими значениями по умолчанию с приоритетом новых.

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

Spec-Zone.ru

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