Packages
phoenix
0.7.2
1.8.9
1.8.8
1.8.7
1.8.6
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.8.0-rc.4
1.8.0-rc.3
1.8.0-rc.2
1.8.0-rc.1
1.8.0-rc.0
1.7.24
1.7.23
1.7.22
1.7.21
1.7.20
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.7.0-rc.3
1.7.0-rc.2
1.7.0-rc.1
1.7.0-rc.0
1.6.17
1.6.16
1.6.15
1.6.14
1.6.13
1.6.12
1.6.11
1.6.10
1.6.9
1.6.8
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.15
1.5.14
1.5.13
1.5.12
1.5.11
1.5.10
1.5.9
1.5.8
1.5.7
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.0
1.4.18
1.4.17
1.4.16
1.4.15
1.4.14
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.4.0-rc.3
1.4.0-rc.2
1.4.0-rc.1
1.4.0-rc.0
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.3.0-rc.3
1.3.0-rc.2
1.3.0-rc.1
1.3.0-rc.0
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc.1
1.2.0-rc.0
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.17.1
0.17.0
0.16.1
0.16.0
0.15.0
0.14.0
0.13.1
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.7.2
0.7.1
0.7.0
0.6.2
0.6.1
0.6.0
0.5.0
0.4.1
0.4.0
0.3.1
0.3.0
0.2.11
0.2.10
0.2.9
0.2.8
0.2.7
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.0
Productive. Reliable. Fast. A productive web framework that does not compromise speed or maintainability.
Security advisory:
This version has known vulnerabilities.
View advisories
Current section
Files
Jump to
Current section
Files
lib/phoenix/controller/flash.ex
defmodule Phoenix.Controller.Flash do
import Plug.Conn
alias Plug.Conn
@http_redir_range 300..308
@moduledoc """
Handles One-time messages, often referred to as "Flash" messages.
Messages can be stored in the session and persisted across redirects for
notices and alerts about request state.
## Examples
def index(conn, _) do
render conn, "index", notice: Flash.get(conn, :notice)
end
def create(conn, _) do
conn
|> Flash.put(:notice, "Created successfully")
|> redirect("/")
end
"""
def init(opts), do: opts
@doc """
Clears the Message dict on new requests
"""
def call(conn = %Conn{private: %{plug_session: _session}}, _) do
register_before_send conn, fn
conn = %Conn{status: stat} when stat in @http_redir_range -> conn
conn -> clear(conn)
end
end
def call(conn, _), do: conn
@doc """
Persists a message in the `Phoenix.Flash`, within the current session
Returns the updated `%Conn{}`
## Examples
iex> conn = %Conn{private: %{plug_session: %{}}}
iex> match? %Conn{}, Flash.put(conn, :notice, "Welcome Back!")
true
"""
def put(conn, key, message) do
persist(conn, put_in(get(conn), [key], [message | get_all(conn, key)]))
end
@doc """
Returns a message from the `Phoenix.Flash`
## Examples
iex> Flash.put(conn, :notice, "Hi!") |> Flash.get
%{notice: "Hi!"}
"""
def get(conn), do: get_session(conn, :phoenix_messages) || %{}
@doc """
Returns a message from the `Phoenix.Flash` by key
## Examples
iex> Flash.put(conn, :notice, "Hello!") |> Flash.get(:notice)
"Hello!"
"""
def get(conn, key) do
case get_in get(conn), [key] do
nil -> nil
[message | _messages] -> message
end
end
@doc """
Returns a list of messages by key from the `Phoenix.Flash`
## Examples
iex> conn
|> Flash.put(:notice, "hello")
|> Flash.put(:notice, "world")
|> Flash.get_all(:notice)
["hello", "world"]
"""
def get_all(conn, key) do
conn
|> get
|> get_in([key])
|> Kernel.||([])
|> Enum.reverse
end
@doc """
Removes all messages from the for given key, returning a `{msgs, conn}` pair
## Examples
iex> %Conn{}
|> Flash.put(:notice, "oh noes!")
|> Flash.put(:notice, "false alarm!")
|> Flash.pop_all(:notice)
{["oh noes!", "false alarm!"], %Conn{}}
"""
def pop_all(conn, key) do
conn
|> get_all(key)
|> case do
[] -> {[], conn}
msgs -> {msgs, persist(conn, Dict.drop(get(conn), [key]))}
end
end
@doc """
Clears all flash messages
"""
def clear(conn), do: persist(conn, %{})
defp persist(conn, messages) do
put_session(conn, :phoenix_messages, messages)
end
end