Pow

v1.0.11

Pow v1.0.11 Pow.Ecto.Context behaviour View Source

Handles pow users context for user.

Usage

This module will be used by pow by default. If you wish to have control over context methods, you can do configure lib/my_project/users/users.ex the following way:

defmodule MyApp.Users do
  use Pow.Ecto.Context,
    repo: MyApp.Repo,
    user: MyApp.Users.User

  def create(params) do
    pow_create(params)
  end
end

Remember to update configuration with users_context: MyApp.Users.

The following Pow methods can be accessed:

  • pow_authenticate/1
  • pow_create/1
  • pow_update/2
  • pow_delete/1
  • pow_get_by/1

Configuration options

  • :repo - the ecto repo module (required)
  • :user - the user schema module (required)
  • :repo_opts - keyword list options for the repo, :prefix can be set here

Link to this section Summary

Types

changeset()
user()

Functions

authenticate(params, config)

Finds a user based on the user id, and verifies the password on the user.

create(params, config)

Creates a new user.

delete(user, config)

Deletes the user.

do_insert(changeset, config)

Inserts a changeset to the database.

do_update(changeset, config)

Updates a changeset in the database.

get_by(clauses, config)

Retrieves an user by the provided clauses.

repo(config) deprecated

See Pow.Config.repo!/1.

update(user, params, config)

Updates the user.

user_schema_mod(config) deprecated

See Pow.Config.user!/1.

Callbacks

authenticate(map)
create(map)
delete(user)
get_by(arg1)
update(user, map)

Link to this section Types

Link to this type

changeset() View Source 
changeset() :: map()

Link to this type

user() View Source 
user() :: map()

Link to this section Functions

Link to this function

authenticate(params, config) View Source 
authenticate(map(), Pow.Config.t()) :: user() | nil

Finds a user based on the user id, and verifies the password on the user.

User schema module and repo module will be fetched from the config. The user id field is fetched from the user schema module.

The method will return nil if either the user id or password is nil.

Link to this function

create(params, config) View Source 
create(map(), Pow.Config.t()) :: {:ok, user()} | {:error, changeset()}

Creates a new user.

User schema module and repo module will be fetched from config.

Link to this function

delete(user, config) View Source 
delete(user(), Pow.Config.t()) :: {:ok, user()} | {:error, changeset()}

Deletes the user.

Repo module will be fetched from the config.

Link to this function

do_insert(changeset, config) View Source 
do_insert(changeset(), Pow.Config.t()) :: {:ok, user()} | {:error, changeset()}

Inserts a changeset to the database.

If succesful, the returned row will be reloaded from the database.

Link to this function

do_update(changeset, config) View Source 
do_update(changeset(), Pow.Config.t()) :: {:ok, user()} | {:error, changeset()}

Updates a changeset in the database.

If succesful, the returned row will be reloaded from the database.

Link to this function

get_by(clauses, config) View Source 
get_by(Keyword.t() | map(), Pow.Config.t()) :: user() | nil

Retrieves an user by the provided clauses.

User schema module and repo module will be fetched from the config.

Link to this function

repo(config) View Source

This function is deprecated. Use `Pow.Config.repo!/1` instead.

See Pow.Config.repo!/1.

Link to this function

update(user, params, config) View Source 
update(user(), map(), Pow.Config.t()) :: {:ok, user()} | {:error, changeset()}

Updates the user.

User schema module will be fetched from provided user and repo will be fetched from the config.

Link to this function

user_schema_mod(config) View Source

This function is deprecated. Use `Pow.Config.user!/1` instead.

See Pow.Config.user!/1.

Link to this section Callbacks

Link to this callback

authenticate(map) View Source 
authenticate(map()) :: user() | nil

Link to this callback

create(map) View Source 
create(map()) :: {:ok, user()} | {:error, changeset()}

Link to this callback

delete(user) View Source 
delete(user()) :: {:ok, user()} | {:error, changeset()}

Link to this callback

get_by(arg1) View Source 
get_by(Keyword.t() | map()) :: user() | nil

Link to this callback

update(user, map) View Source 
update(user(), map()) :: {:ok, user()} | {:error, changeset()}