Docs4dev
Docs
rails / 5.0 / abstractcontroller / rendering.html

module AbstractController::Rendering

Included modules:
ActionView::ViewPaths

Constants

DEFAULT_PROTECTED_INSTANCE_VARIABLES

Public Instance Methods

_normalize_args(action=nil, options={}) Show source 
# File actionpack/lib/abstract_controller/rendering.rb, line 83
def _normalize_args(action=nil, options={})
  if action.respond_to?(:permitted?)
    if action.permitted?
      action
    else
      raise ArgumentError, "render parameters are not permitted"
    end
  elsif action.is_a?(Hash)
    action
  else
    options
  end
end

Normalize args by converting render "foo" to render :action => "foo" and render "foo/bar" to render :file => "foo/bar". :api: plugin

_normalize_options(options) Show source 
# File actionpack/lib/abstract_controller/rendering.rb, line 99
def _normalize_options(options)
  options
end

Normalize options. :api: plugin

_normalize_render(*args, &block) Show source 
# File actionpack/lib/abstract_controller/rendering.rb, line 122
def _normalize_render(*args, &block)
  options = _normalize_args(*args, &block)
  #TODO: remove defined? when we restore AP <=> AV dependency
  if defined?(request) && !request.nil? && request.variant.present?
    options[:variant] = request.variant
  end
  _normalize_options(options)
  options
end

Normalize args and options. :api: private

_process_format(format) Show source 
# File actionpack/lib/abstract_controller/rendering.rb, line 111
def _process_format(format)
end

Process the rendered format. :api: private

_process_options(options) Show source 
# File actionpack/lib/abstract_controller/rendering.rb, line 105
def _process_options(options)
  options
end

Process extra options. :api: plugin

render(*args, &block) Show source 
# File actionpack/lib/abstract_controller/rendering.rb, line 24
def render(*args, &block)
  options = _normalize_render(*args, &block)
  rendered_body = render_to_body(options)
  if options[:html]
    _set_html_content_type
  else
    _set_rendered_content_type rendered_format
  end
  self.response_body = rendered_body
end

Normalizes arguments, options and then delegates #render_to_body and sticks the result in self.response_body. :api: public

render_to_body(options = {}) Show source 
# File actionpack/lib/abstract_controller/rendering.rb, line 53
def render_to_body(options = {})
end

Performs the actual template rendering. :api: public

render_to_string(*args, &block) Show source 
# File actionpack/lib/abstract_controller/rendering.rb, line 46
def render_to_string(*args, &block)
  options = _normalize_render(*args, &block)
  render_to_body(options)
end

Raw rendering of a template to a string.

It is similar to render, except that it does not set the response_body and it should be guaranteed to always return a string.

If a component extends the semantics of response_body (as ActionController extends it to be anything that responds to the method each), this method needs to be overridden in order to still return a string. :api: plugin

rendered_format() Show source 
# File actionpack/lib/abstract_controller/rendering.rb, line 58
def rendered_format
  Mime[:text]
end

Returns Content-Type of rendered content :api: public

view_assigns() Show source 
# File actionpack/lib/abstract_controller/rendering.rb, line 69
def view_assigns
  protected_vars = _protected_ivars
  variables      = instance_variables

  variables.reject! { |s| protected_vars.include? s }
  variables.each_with_object({}) { |name, hash|
    hash[name.slice(1, name.length)] = instance_variable_get(name)
  }
end

This method should return a hash with assigns. You can overwrite this configuration per controller. :api: public

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