Franklin
v0.1.0

View Source Franklin.Accounts.User (Franklin v0.1.0)

Link to this section Summary

Types

id()
t()

Functions

confirm_changeset(user)

Confirms the account by setting confirmed_at.

email_changeset(user, attrs, opts \\ [])

A user changeset for changing the email.

password_changeset(user, attrs, opts \\ [])

A user changeset for changing the password.

registration_changeset(user, attrs, opts \\ [])

A user changeset for registration.

valid_password?(arg1, password)

Verifies the password.

validate_current_password(changeset, password)

Validates the current password otherwise adds an error to the changeset.

Link to this section Types

Link to this type

id()

View Source 
@type id() :: Ecto.UUID.t()
Link to this type

t()

View Source 
@type t() :: %Franklin.Accounts.User{
  __meta__: term(),
  confirmed_at: DateTime.t() | nil,
  email: String.t(),
  hashed_password: String.t(),
  id: id(),
  inserted_at: term(),
  password: String.t() | nil,
  updated_at: term()
}

Link to this section Functions

Link to this function

confirm_changeset(user)

View Source

Confirms the account by setting confirmed_at.

Link to this function

email_changeset(user, attrs, opts \\ [])

View Source

A user changeset for changing the email.

It requires the email to change otherwise an error is added.

Link to this function

password_changeset(user, attrs, opts \\ [])

View Source

A user changeset for changing the password.

options

 Options

  • :hash_password - Hashes the password so it can be stored securely in the database and ensures the password field is cleared to prevent leaks in the logs. If password hashing is not needed and clearing the password field is not desired (like when using this changeset for validations on a LiveView form), this option can be set to false. Defaults to true.
Link to this function

registration_changeset(user, attrs, opts \\ [])

View Source

A user changeset for registration.

It is important to validate the length of both email and password. Otherwise databases may truncate the email without warnings, which could lead to unpredictable or insecure behaviour. Long passwords may also be very expensive to hash for certain algorithms.

options

 Options

  • :hash_password - Hashes the password so it can be stored securely in the database and ensures the password field is cleared to prevent leaks in the logs. If password hashing is not needed and clearing the password field is not desired (like when using this changeset for validations on a LiveView form), this option can be set to false. Defaults to true.

  • :validate_email - Validates the uniqueness of the email, in case you don't want to validate the uniqueness of the email (like when using this changeset for validations on a LiveView form before submitting the form), this option can be set to false. Defaults to true.

Link to this function

valid_password?(arg1, password)

View Source

Verifies the password.

If there is no user or the user doesn't have a password, we call Argon2.no_user_verify/0 to avoid timing attacks.

Link to this function

validate_current_password(changeset, password)

View Source

Validates the current password otherwise adds an error to the changeset.