PhoenixKitStaff.Departments (PhoenixKitStaff v0.2.0)

CRUD for departments.

Summary

Functions

change(dept, attrs \\ %{})

Returns a changeset for the given department.

count()

Total number of departments.

create(attrs)

Inserts a department and broadcasts :department_created.

delete(dept)

Deletes a department and broadcasts :department_deleted.

get(uuid, opts \\ [])

Fetches a department by uuid, or nil if not found.

get!(uuid, opts \\ [])

Fetches a department by uuid. Raises if not found.

list(opts \\ [])

Lists departments. Accepts :preload.

update(dept, attrs)

Updates a department and broadcasts :department_updated.

Functions

change(dept, attrs \\ %{})

@spec change(PhoenixKitStaff.Schemas.Department.t(), map()) ::
  Ecto.Changeset.t(PhoenixKitStaff.Schemas.Department.t())

Returns a changeset for the given department.

count()

@spec count() :: non_neg_integer()

Total number of departments.

create(attrs)

@spec create(map()) ::
  {:ok, PhoenixKitStaff.Schemas.Department.t()}
  | {:error, Ecto.Changeset.t(PhoenixKitStaff.Schemas.Department.t())}

Inserts a department and broadcasts :department_created.

delete(dept)

@spec delete(PhoenixKitStaff.Schemas.Department.t()) ::
  {:ok, PhoenixKitStaff.Schemas.Department.t()}
  | {:error, Ecto.Changeset.t(PhoenixKitStaff.Schemas.Department.t())}

Deletes a department and broadcasts :department_deleted.

get(uuid, opts \\ [])

@spec get(
  UUIDv7.t() | String.t(),
  keyword()
) :: PhoenixKitStaff.Schemas.Department.t() | nil

Fetches a department by uuid, or nil if not found.

get!(uuid, opts \\ [])

@spec get!(
  UUIDv7.t() | String.t(),
  keyword()
) :: PhoenixKitStaff.Schemas.Department.t()

Fetches a department by uuid. Raises if not found.

list(opts \\ [])

@spec list(keyword()) :: [PhoenixKitStaff.Schemas.Department.t()]

Lists departments. Accepts :preload.

update(dept, attrs)

@spec update(PhoenixKitStaff.Schemas.Department.t(), map()) ::
  {:ok, PhoenixKitStaff.Schemas.Department.t()}
  | {:error, Ecto.Changeset.t(PhoenixKitStaff.Schemas.Department.t())}

Updates a department and broadcasts :department_updated.