epochtalk_server v0.1.0

EpochtalkServer.Models.Category (epochtalk_server v0.1.0)

Category model, for performing actions relating to forum categories

Link to this section Summary

Types

t()

Functions

changeset(category, attrs)

Create generic changeset for Category model

create(attrs)

Creates a new Category in the database

create_changeset(category, attrs)

Creates changeset for inserting a new Category model

update_for_board_mapping(category_map)

Updates an existing Category in the database, used by board mapping to recategorize boards

update_for_board_mapping_changeset(category, attrs)

Creates changeset for updating an existing Category model

Link to this section Types

Link to this type

t()

@type t() :: %EpochtalkServer.Models.Category{
  __meta__: term(),
  boards: [EpochtalkServer.Models.Board.t()] | term(),
  created_at: NaiveDateTime.t() | nil,
  id: non_neg_integer() | nil,
  imported_at: NaiveDateTime.t() | nil,
  meta: map() | nil,
  name: String.t() | nil,
  postable_by: non_neg_integer() | nil,
  updated_at: NaiveDateTime.t() | nil,
  view_order: non_neg_integer() | nil,
  viewable_by: non_neg_integer() | nil
}

Link to this section Functions

Link to this function

changeset(category, attrs)

@spec changeset(category :: t(), attrs :: map() | nil) :: Ecto.Changeset.t()

Create generic changeset for Category model

Link to this function

create(attrs)

@spec create(category_attrs :: map()) ::
  {:ok, category :: t()} | {:error, Ecto.Changeset.t()}

Creates a new Category in the database

Link to this function

create_changeset(category, attrs)

@spec create_changeset(category :: t(), attrs :: map() | nil) :: Ecto.Changeset.t()

Creates changeset for inserting a new Category model

Link to this function

update_for_board_mapping(category_map)

@spec update_for_board_mapping(category_map :: %{id: id :: integer()}) ::
  {:ok, category :: t()} | {:error, Ecto.Changeset.t()}

Updates an existing Category in the database, used by board mapping to recategorize boards

Link to this function

update_for_board_mapping_changeset(category, attrs)

@spec update_for_board_mapping_changeset(category :: t(), attrs :: map() | nil) ::
  Ecto.Changeset.t()

Creates changeset for updating an existing Category model