View Source Pow.Phoenix.Controller (Pow v1.0.36)

Used with Pow Phoenix controllers to handle messages, routes and callbacks.

Usage

defmodule MyPowExtension.Phoenix.MyController do
  use Pow.Phoenix.Controller

  def process_new(conn, _params) do
    {:ok, :response, conn}
  end

  def respond_new({:ok, :response, conn}) do
    render(conn, "new.html")
  end
end

Configuration options

:messages_backend - See Pow.Phoenix.Messages for more.
:routes_backend - See Pow.Phoenix.Routes for more.
:controller_callbacks - See Pow.Extension.Phoenix.ControllerCallbacks for more.

Summary

Functions

action(controller, conn, params)

Handles the controller action call.

messages(conn, fallback)

Fetches messages backend from configuration, or use fallback.

put_no_cache_header(conn, opts)

Ensures that the page can't be cached in browser.

require_authenticated(conn, opts)

Ensures that user has been authenticated.

require_not_authenticated(conn, opts)

Ensures that user hasn't been authenticated.

route_helper(plug)

routes(conn, fallback)

Fetches routes backend from configuration, or use fallback.

Functions

action(controller, conn, params)

@spec action(atom(), Plug.Conn.t(), map()) :: Plug.Conn.t()

Handles the controller action call.

If a :controller_callbacks module has been set in the configuration, then before_process and before_respond will be called on this module on all actions.

messages(conn, fallback)

@spec messages(Plug.Conn.t(), atom()) :: atom()

Fetches messages backend from configuration, or use fallback.

put_no_cache_header(conn, opts)

@spec put_no_cache_header(Plug.Conn.t(), Keyword.t()) :: Plug.Conn.t()

Ensures that the page can't be cached in browser.

This will add a "cache-control" header with "no-cache, no-store, must-revalidate" if the cache control header hasn't been changed from the default value in the Plug.Conn struct.

require_authenticated(conn, opts)

@spec require_authenticated(Plug.Conn.t(), Keyword.t()) :: Plug.Conn.t()

Ensures that user has been authenticated.

Pow.Phoenix.PlugErrorHandler is used as error handler. See Pow.Plug.RequireAuthenticated for more.

require_not_authenticated(conn, opts)

@spec require_not_authenticated(Plug.Conn.t(), Keyword.t()) :: Plug.Conn.t()

Ensures that user hasn't been authenticated.

Pow.Phoenix.PlugErrorHandler is used as error handler. See Pow.Plug.RequireNotAuthenticated for more.

route_helper(plug)

@spec route_helper(atom()) :: binary()

routes(conn, fallback)

@spec routes(Plug.Conn.t(), atom()) :: atom()

Fetches routes backend from configuration, or use fallback.