View Source Mobilizon.Resources (Mobilizon v4.1.0-alpha.1)

The Resources context.

Summary

Functions

create_resource(attrs \\ %{})

Creates a resource.

delete_resource(resource)

Deletes a resource

get_resource(id)

Get a resource by it's ID

get_resource_by_group_and_path_with_preloads(group_id, path)

get_resource_by_url(url)

Get a resource by it's URL

get_resource_by_url_with_preloads(url)

get_resource_with_preloads(id)

get_resources_for_folder(resource, page \\ nil, limit \\ nil)

Returns the list of resources for a resource folder.

get_resources_for_group(actor, page \\ nil, limit \\ nil)

Returns the list of recent resources for a group

update_resource(resource, attrs)

Updates a resource.

Functions

create_resource(attrs \\ %{})

@spec create_resource(map()) ::
  {:ok, Mobilizon.Resources.Resource.t()} | {:error, Ecto.Changeset.t()}

Creates a resource.

delete_resource(resource)

@spec delete_resource(Mobilizon.Resources.Resource.t()) ::
  {:ok, Mobilizon.Resources.Resource.t()} | {:error, Ecto.Changeset.t()}

Deletes a resource

get_resource(id)

@spec get_resource(integer() | String.t()) :: Mobilizon.Resources.Resource.t() | nil

Get a resource by it's ID

get_resource_by_group_and_path_with_preloads(group_id, path)

@spec get_resource_by_group_and_path_with_preloads(String.t() | integer(), String.t()) ::
  Mobilizon.Resources.Resource.t() | nil

get_resource_by_url(url)

@spec get_resource_by_url(String.t()) :: Mobilizon.Resources.Resource.t() | nil

Get a resource by it's URL

get_resource_by_url_with_preloads(url)

@spec get_resource_by_url_with_preloads(String.t()) ::
  Mobilizon.Resources.Resource.t() | nil

get_resource_with_preloads(id)

@spec get_resource_with_preloads(integer() | String.t()) ::
  Mobilizon.Resources.Resource.t() | nil

get_resources_for_folder(resource, page \\ nil, limit \\ nil)

@spec get_resources_for_folder(
  Mobilizon.Resources.Resource.t(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Resources.Resource.t())

Returns the list of resources for a resource folder.

get_resources_for_group(actor, page \\ nil, limit \\ nil)

@spec get_resources_for_group(
  Mobilizon.Actors.Actor.t(),
  integer() | nil,
  integer() | nil
) ::
  Mobilizon.Storage.Page.t(Mobilizon.Resources.Resource.t())

Returns the list of recent resources for a group

update_resource(resource, attrs)

@spec update_resource(Mobilizon.Resources.Resource.t(), map()) ::
  {:ok, Mobilizon.Resources.Resource.t()} | {:error, Ecto.Changeset.t()}

Updates a resource.

Since a resource can be a folder and hold children, we do the following in a transaction:

Get the parent path so that we can reconstruct the path for current resource (if moved or simply renamed)
Update all children with the new parent path
Update the resource path itself