View Source Bonfire.Social.Edges (Bonfire v0.9.10-classic-beta.169)

Shared helpers for modules that implemented Edges to mutate or query them, preload relevant associations, etc.

This is a shared context for Bonfire.Data.Edges.Edge, which has these fields:

id: primary key which matches the related Activity
subject: the who (eg. a user)
table: what kind of action (eg. references Like or Follow in Needle.Table ...)
object: the what (eg. a specific post)

Summary

Functions

changeset(schema, subject, verb, object, options)

Prepares a full changeset for the given schema, subject, verb, object, and options.

changeset_base(schema, subject, object, options)

Prepares a basic schema, with the schema type as top-level and an Egde assoc

changeset_base_with_creator(schema, subject, object, options)

Prepares a changeset with creator but no caretaker, which avoids the edge being deleted when subject is deleted.

changeset_extra(schema, subject, verb, object, options)

Prepares a changeset with Acls, Activities and FeedActivities

changeset_without_caretaker(schema, subject, verb, object, options)

Prepares a changeset with creator but no caretaker, which avoids the edge being deleted when subject is deleted. Also includes Acls, Activities and FeedActivities.

count(type, filters_or_object, opts \\ [])

Counts the edges for the given type, filters or object, and options.

count_for_subject(type, subject, object, opts)

Counts the edges for the given type, subject, object, and options.

delete_by_both(me, schema, object)

Deletes edges by subject, type, and object

delete_by_object(user)

Deletes edges where the given user is the object.

delete_by_subject(user)

Deletes edges where the given user is the subject.

edge_module_query(schema_or_context, args)

exists?(schema_or_context, subject, object, opts)

Checks if an edge exists with the given schema/context, subject, and object.

filters_from_opts(assigns)

TODOC

get(schema_or_context, subject, object, opts \\ [])

Retrieves the edge with either

get!(schema_or_context, subject, objects, opts \\ [])

insert(changeset, subject \\ nil, object \\ nil)

Inserts a changeset with optional subject and object.

insert(schema, subject, verb, object, options)

Inserts a new edge with the given schema, subject, verb, and object.

last(schema_or_context, subject, object, opts)

Retrieves the last edge of a given type, subject, and object from the database.

last_date(type, subject, object, opts)

Retrieves the date of the last edge of a given type, subject, and object from the database.

put_edge_assoc(changeset, subject, object)

put_edge_assoc(changeset, type_of_edge_schema, subject, object)

query(filters, opts)

TODOC

query_parent(query_schema, filters, opts)

TODOC

Functions

changeset(schema, subject, verb, object, options)

Prepares a full changeset for the given schema, subject, verb, object, and options.

Examples

iex> changeset(MySchema, %User{id: 1}, :like, %Post{id: 2}, [])
%Ecto.Changeset{}

changeset_base(schema, subject, object, options)

Prepares a basic schema, with the schema type as top-level and an Egde assoc

iex> changeset_base(Like, %User{id: 1}, %Post{id: 2}, [])

%Ecto.Changeset{}

iex> changeset_base(Follow, %User{id: 1}, %User{id: 2}, [])

%Ecto.Changeset{}

iex> changeset_base({Request, Follow}, %User{id: 1}, %User{id: 2}, [])

%Ecto.Changeset{}

changeset_base_with_creator(schema, subject, object, options)

Prepares a changeset with creator but no caretaker, which avoids the edge being deleted when subject is deleted.

Examples

iex> changeset_base_with_creator(MySchema, %User{id: 1}, %Post{id: 2}, [])
%Ecto.Changeset{}

changeset_extra(schema, subject, verb, object, options)

Prepares a changeset with Acls, Activities and FeedActivities

changeset_without_caretaker(schema, subject, verb, object, options)

Prepares a changeset with creator but no caretaker, which avoids the edge being deleted when subject is deleted. Also includes Acls, Activities and FeedActivities.

Examples

iex> changeset_without_caretaker(MySchema, %User{id: 1}, :like, %Post{id: 2}, [])
%Ecto.Changeset{}

count(type, filters_or_object, opts \\ [])

Counts the edges for the given type, filters or object, and options.

Examples

> count(:like, %Post{id: 2}, [])
42

count_for_subject(type, subject, object, opts)

Counts the edges for the given type, subject, object, and options.

Examples

> count_for_subject(:like, %User{id: 1}, %Post{id: 2}, [])
42

delete_by_both(me, schema, object)

Deletes edges by subject, type, and object

Examples

iex> delete_by_both(%User{id: 1}, MySchema, %User{id: 2})
:ok

delete_by_object(user)

Deletes edges where the given user is the object.

Examples

iex> delete_by_object(%User{id: 1})
:ok

delete_by_subject(user)

Deletes edges where the given user is the subject.

Examples

iex> delete_by_subject(%User{id: 1})
:ok

edge_module_query(schema_or_context, args)

exists?(schema_or_context, subject, object, opts)

Checks if an edge exists with the given schema/context, subject, and object.

Examples

> exists?(MySchema, %User{id: 1}, %Post{id: 2}, [])
true

filters_from_opts(assigns)

TODOC

get(schema_or_context, subject, object, opts \\ [])

Retrieves the edge with either:

a schema/context, subject, and object(s)
a schema/context, filters, and options

Examples

> get(MySchema, %User{id: 1}, %Post{id: 2})

> get(MySchema, [%{subject: %User{id: 1}}], [])

get!(schema_or_context, subject, objects, opts \\ [])

insert(changeset, subject \\ nil, object \\ nil)

Inserts a changeset with optional subject and object.

Examples

iex> insert(%Changeset{}, %User{id: 1}, %Post{id: 2})
{:ok, %Edge{}}

insert(schema, subject, verb, object, options)

Inserts a new edge with the given schema, subject, verb, and object.

Examples

> insert(MySchema, %User{id: 1}, :like, %Post{id: 2}, [])
{:ok, %Edge{}}

last(schema_or_context, subject, object, opts)

Retrieves the last edge of a given type, subject, and object from the database.

Examples

iex> last(MySchema, %User{id: 1}, %Post{id: 2}, [])

last_date(type, subject, object, opts)

Retrieves the date of the last edge of a given type, subject, and object from the database.

Examples

> last_date(:like, %User{id: 1}, %Post{id: 2}, [])
~N[2023-07-25 12:34:56]