philomena/lib/philomena/forums.ex
2024-07-02 17:21:52 -04:00

108 lines
1.8 KiB
Elixir

defmodule Philomena.Forums do
@moduledoc """
The Forums context.
"""
import Ecto.Query, warn: false
alias Philomena.Repo
alias Philomena.Forums.Forum
use Philomena.Subscriptions,
actor_types: ~w(Forum),
id_name: :forum_id
@doc """
Returns the list of forums.
## Examples
iex> list_forums()
[%Forum{}, ...]
"""
def list_forums do
Repo.all(Forum)
end
@doc """
Gets a single forum.
Raises `Ecto.NoResultsError` if the Forum does not exist.
## Examples
iex> get_forum!(123)
%Forum{}
iex> get_forum!(456)
** (Ecto.NoResultsError)
"""
def get_forum!(id), do: Repo.get!(Forum, id)
@doc """
Creates a forum.
## Examples
iex> create_forum(%{field: value})
{:ok, %Forum{}}
iex> create_forum(%{field: bad_value})
{:error, %Ecto.Changeset{}}
"""
def create_forum(attrs \\ %{}) do
%Forum{}
|> Forum.changeset(attrs)
|> Repo.insert()
end
@doc """
Updates a forum.
## Examples
iex> update_forum(forum, %{field: new_value})
{:ok, %Forum{}}
iex> update_forum(forum, %{field: bad_value})
{:error, %Ecto.Changeset{}}
"""
def update_forum(%Forum{} = forum, attrs) do
forum
|> Forum.changeset(attrs)
|> Repo.update()
end
@doc """
Deletes a Forum.
## Examples
iex> delete_forum(forum)
{:ok, %Forum{}}
iex> delete_forum(forum)
{:error, %Ecto.Changeset{}}
"""
def delete_forum(%Forum{} = forum) do
Repo.delete(forum)
end
@doc """
Returns an `%Ecto.Changeset{}` for tracking forum changes.
## Examples
iex> change_forum(forum)
%Ecto.Changeset{source: %Forum{}}
"""
def change_forum(%Forum{} = forum) do
Forum.changeset(forum, %{})
end
end