Bonfire.Classify.Tree (Bonfire v1.0.0-social-rc.2.18)

View Source

A mixin used to record parent/child relationships between categories (eg. a topic that belongs to a group) and between objects and categories (eg. a post was published in a topic)

Summary

Types

t()

Functions

ancestor_ids(schema)
ancestors(schema)
arrange(structs_list, opts \\ [])
build_child(schema)
changeset(tree \\ %Tree{}, attrs)
children(schema)
delete(struct, key)
depth(schema)
descendants(schema)
get(struct, key, default \\ nil)
make_child_of(changeset, parent)
parent(schema)
parent_id(schema)
path(schema)
path_ids(schema)
put(struct, key, val)
put_tree(changeset, custodian, parent)
root(schema)
root?(schema)
root_id(schema)
siblings(schema)
subtree(schema)
where_depth(query \\ __MODULE__, depth_params)

Types

t()

@type t() :: %Bonfire.Classify.Tree{
  __meta__: Ecto.Schema.Metadata.t(),
  custodian: Ecto.Schema.belongs_to(Needle.Pointer.t()) | nil,
  custodian_id: Needle.UID.t() | nil,
  direct_children_count: integer() | nil,
  id: Needle.UID.t() | nil,
  nested_children_count: integer() | nil,
  parent: Ecto.Schema.belongs_to(Bonfire.Classify.Category.t()) | nil,
  parent_id: Needle.UID.t() | nil,
  path: EctoMaterializedPath.UIDs.t() | nil,
  pointer: Ecto.Schema.belongs_to(Needle.Pointer.t()) | nil
}

Functions

ancestor_ids(schema)

ancestors(schema)

arrange(structs_list, opts \\ [])

build_child(schema)

changeset(tree \\ %Tree{}, attrs)

children(schema)

delete(struct, key)

depth(schema)

descendants(schema)

get(struct, key, default \\ nil)

make_child_of(changeset, parent)

parent(schema)

parent_id(schema)

path(schema)

path_ids(schema)

put(struct, key, val)

put_tree(changeset, custodian, parent)

root(schema)

root?(schema)

root_id(schema)

siblings(schema)

subtree(schema)

where_depth(query \\ __MODULE__, depth_params)