diff options
author | Jamis Buck <jamis@37signals.com> | 2005-10-16 15:42:03 +0000 |
---|---|---|
committer | Jamis Buck <jamis@37signals.com> | 2005-10-16 15:42:03 +0000 |
commit | 1c057b7237c98d948b08b80c0ac403cda3028dab (patch) | |
tree | 455dc930b10a4408f4b25fb97c156a6abdb8a755 /actionpack/lib/action_controller/flash.rb | |
parent | 59f1df1b5b37a9e16a6b03d931c7b620075034d5 (diff) | |
download | rails-1c057b7237c98d948b08b80c0ac403cda3028dab.tar.gz rails-1c057b7237c98d948b08b80c0ac403cda3028dab.tar.bz2 rails-1c057b7237c98d948b08b80c0ac403cda3028dab.zip |
Update/clean up AP documentation (rdoc)
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@2649 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
Diffstat (limited to 'actionpack/lib/action_controller/flash.rb')
-rw-r--r-- | actionpack/lib/action_controller/flash.rb | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/actionpack/lib/action_controller/flash.rb b/actionpack/lib/action_controller/flash.rb index 90c464dd81..674f73f1a4 100644 --- a/actionpack/lib/action_controller/flash.rb +++ b/actionpack/lib/action_controller/flash.rb @@ -1,14 +1,14 @@ module ActionController #:nodoc: # 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 <tt>flash["notice"] = "Successfully created"</tt> before redirecting to a display action that can then expose + # that sets <tt>flash[:notice] = "Successfully created"</tt> 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 } + # flash[:notice] = "Successfully created post" + # redirect_to :action => "display", :params => { :id => post.id } # end # # def display @@ -17,7 +17,7 @@ module ActionController #:nodoc: # end # # display.rhtml - # <% if @flash["notice"] %><div class="notice"><%= @flash["notice"] %></div><% end %> + # <% 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. @@ -67,7 +67,7 @@ module ActionController #:nodoc: # Sets a flash that will not be available to the next action, only to the current. # - # flash.now["message"] = "Hello current action" + # flash.now[:message] = "Hello current action" # # This method enables you to use the flash as a central messaging system in your app. # When you need to pass an object to the next action, you use the standard flash assign (<tt>[]=</tt>). @@ -82,7 +82,7 @@ module ActionController #:nodoc: # Keeps either the entire current flash or a specific flash entry available for the next action: # # flash.keep # keeps the entire flash - # flash.keep("notice") # keeps only the "notice" entry, the rest of the flash is discarded + # flash.keep(:notice) # keeps only the "notice" entry, the rest of the flash is discarded def keep(k=nil) use(k, false) end @@ -90,7 +90,7 @@ module ActionController #:nodoc: # Marks the entire flash or a single flash entry to be discarded by the end of the current action # # flash.keep # keep entire flash available for the next action - # flash.discard('warning') # discard the "warning" entry (it'll still be available for the current action) + # flash.discard(:warning) # discard the "warning" entry (it'll still be available for the current action) def discard(k=nil) use(k) end |