Class ActionDispatch::Flash::FlashHash
In: lib/action_dispatch/middleware/flash.rb
Parent: Object

Methods

[]   alert   alert=   clear   close!   delete   discard   each   empty?   initialize_copy   keep   key?   keys   notice   notice=   now   now_is_loaded?   to_hash   use  

Included Modules

Enumerable

External Aliases

update -> merge!
closed -> closed?

Attributes

closed  [R] 

Public Instance methods

Convenience accessor for flash[:alert]

Convenience accessor for flash[:alert]=

Marks the entire flash or a single flash entry to be discarded by the end of the current action:

    flash.discard              # discard the entire flash at the end of the current action
    flash.discard(:warning)    # discard only the "warning" entry at the end of the current action

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

Convenience accessor for flash[:notice]

Convenience accessor for flash[:notice]=

Sets a flash that will not be available to the next action, only to the current.

    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 ([]=). When you need to pass an object to the current action, you use now, and your object will vanish when the current action is done.

Entries set via now are accessed the same way as standard entries: flash[‘my-key’].

Protected Instance methods

Used internally by the keep and discard methods

    use()               # marks the entire flash as used
    use('msg')          # marks the "msg" entry as used
    use(nil, false)     # marks the entire flash as unused (keeps it around for one more action)
    use('msg', false)   # marks the "msg" entry as unused (keeps it around for one more action)

Returns the single value for the key you asked to be marked (un)used or the FlashHash itself if no key is passed.

[Validate]