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.
Access the contents of the flash. Use flash["notice"] to read a notice you put there or flash["notice"] = "hello" to put a new one. Note that if sessions are disabled only flash.now will work.
[ show source ]
# File vendor/rails/actionpack/lib/action_controller/flash.rb, line 141
141: def flash #:doc:
142: # @session = Hash.new if sessions are disabled
143: if @session.is_a?(Hash)
144: @__flash ||= FlashHash.new
145:
146: # otherwise, @session is a CGI::Session or a TestSession
147: else
148: @session['flash'] ||= FlashHash.new
149: end
150: end
deprecated. use flash.keep instead
[ show source ]
# File vendor/rails/actionpack/lib/action_controller/flash.rb, line 153
153: def keep_flash #:doc:
154: warn 'keep_flash is deprecated; use flash.keep instead.'
155: flash.keep
156: end