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"] = "Succesfully 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"] = "Succesfully 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.
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.
[ show source ]
# File lib/action_controller/flash.rb, line 34
34: def flash #:doc:
35: if @session["flash"].nil?
36: @session["flash"] = {}
37: @session["flashes"] ||= 0
38: end
39: @session["flash"]
40: end
Can be called by any action that would like to keep the current content of the flash around for one more action.
[ show source ]
# File lib/action_controller/flash.rb, line 43
43: def keep_flash #:doc:
44: @session["flashes"] = 0
45: end
[ show source ]
# File lib/action_controller/flash.rb, line 58
58: def clear_flash
59: if @session["flash"] && (@session["flashes"].nil? || @session["flashes"] >= 1)
60: @session["flash"] = {}
61: @session["flashes"] = 0
62: end
63: end
Records that the contents of @session["flash"] was flashed to the action
[ show source ]
# File lib/action_controller/flash.rb, line 49
49: def fire_flash
50: if @session["flash"]
51: @session["flashes"] += 1 unless @session["flash"].empty?
52: @assigns["flash"] = @session["flash"]
53: else
54: @assigns["flash"] = {}
55: end
56: end