ActionDispatch::Flash::FlashHash

Public Instance Methods

alert() click to toggle source

Convenience accessor for flash[:alert]

     # File lib/action_dispatch/middleware/flash.rb, line 140
140:       def alert
141:         self[:alert]
142:       end

alert=(message) click to toggle source

Convenience accessor for flash[:alert]=

     # File lib/action_dispatch/middleware/flash.rb, line 145
145:       def alert=(message)
146:         self[:alert] = message
147:       end

discard(k = nil) click to toggle source

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

     # File lib/action_dispatch/middleware/flash.rb, line 118
118:       def discard(k = nil)
119:         use(k)
120:       end

keep(k = nil) click to toggle source

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

     # File lib/action_dispatch/middleware/flash.rb, line 110
110:       def keep(k = nil)
111:         use(k, false)
112:       end

notice() click to toggle source

Convenience accessor for flash[:notice]

     # File lib/action_dispatch/middleware/flash.rb, line 150
150:       def notice
151:         self[:notice]
152:       end

notice=(message) click to toggle source

Convenience accessor for flash[:notice]=

     # File lib/action_dispatch/middleware/flash.rb, line 155
155:       def notice=(message)
156:         self[:notice] = message
157:       end

now() click to toggle source

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'].

     # File lib/action_dispatch/middleware/flash.rb, line 102
102:       def now
103:         FlashNow.new(self)
104:       end

Private Instance Methods

use(key = nil, used = true) click to toggle source

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.

     # File lib/action_dispatch/middleware/flash.rb, line 167
167:         def use(key = nil, used = true)
168:           Array(key || keys).each { |k| used ? @used << k : @used.delete(k) }
169:           return key ? self[key] : self
170:         end

Home Classes Methods

In Files

Parent

Methods

Class Index

ActionDispatch::Flash::FlashHash

Public Instance Methods

Private Instance Methods