Module: ActionController::Flash

Defined in:
lib/action_controller/flash.rb

Overview

The flash provides a way to pass temporary objects between actions. Anything you place in the flash will be exposed to the very next action and then cleared out. This is a great way of doing notices and alerts, such as a create action that sets flash[:notice] = "Successfully created" before redirecting to a display action that can then expose the flash to its template. Actually, that exposure is automatically done. Example:

class WeblogController < ActionController::Base
  def create
    # save post
    flash[:notice] = "Successfully created post"
    redirect_to :action => "display", :params => { :id => post.id }
  end

  def display
    # doesn't need to assign the flash notice to the template, that's done automatically
  end
end

display.rhtml
  <% if @flash[:notice] %><div class="notice"><%= @flash[:notice] %></div><% end %>

This example just places a string in the flash, but you can put any object in there. And of course, you can put as many as you like at a time too. Just remember: They’ll be gone by the time the next action has been performed.

See docs on the FlashHash class for more details about the flash.

Defined Under Namespace

Modules: InstanceMethods Classes: FlashHash, FlashNow

Class Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/action_controller/flash.rb', line 27

def self.included(base)
  base.send :include, InstanceMethods

  base.class_eval do
    alias_method :assign_shortcuts_without_flash, :assign_shortcuts
    alias_method :assign_shortcuts, :assign_shortcuts_with_flash

    alias_method :process_cleanup_without_flash, :process_cleanup
    alias_method :process_cleanup, :process_cleanup_with_flash
  end
end