ScalesCms.Cms.CmsMediaLibrary (scales_cms v0.2.0)

Copy Markdown

The CmsMediaLibrary context.

Summary

Functions

Returns an %Ecto.Changeset{} for tracking media library item changes.

Creates a media library item.

Soft deletes a media library item by setting deleted_at.

Gets a single media library item.

Gets a single media library item.

Hard deletes a media library item from the database.

Returns the list of all media library items.

Returns the list of media library items filtered by type.

Searches media library items by name.

Searches media library items by name and type.

Functions

change_media_library_item(media_library_item, attrs \\ %{})

Returns an %Ecto.Changeset{} for tracking media library item changes.

Examples

iex> change_media_library_item(media_library_item)
%Ecto.Changeset{data: %CmsMediaLibraryItem{}}

create_media_library_item(attrs \\ %{})

Creates a media library item.

Examples

iex> create_media_library_item(%{field: value})
{:ok, %CmsMediaLibraryItem{}}

iex> create_media_library_item(%{field: bad_value})
{:error, %Ecto.Changeset{}}

delete_media_library_item(media_library_item)

Soft deletes a media library item by setting deleted_at.

Examples

iex> delete_media_library_item(media_library_item)
{:ok, %CmsMediaLibraryItem{}}

iex> delete_media_library_item(media_library_item)
{:error, %Ecto.Changeset{}}

get_media_library_item(id)

Gets a single media library item.

Returns nil if the item does not exist.

Examples

iex> get_media_library_item(123)
%CmsMediaLibraryItem{}

iex> get_media_library_item(456)
nil

get_media_library_item!(id)

Gets a single media library item.

Raises Ecto.NoResultsError if the item does not exist.

Examples

iex> get_media_library_item!(123)
%CmsMediaLibraryItem{}

iex> get_media_library_item!(456)
** (Ecto.NoResultsError)

hard_delete_media_library_item(media_library_item)

Hard deletes a media library item from the database.

Examples

iex> hard_delete_media_library_item(media_library_item)
{:ok, %CmsMediaLibraryItem{}}

iex> hard_delete_media_library_item(media_library_item)
{:error, %Ecto.Changeset{}}

list_media_library_items()

Returns the list of all media library items.

Examples

iex> list_media_library_items()
[%CmsMediaLibraryItem{}, ...]

list_media_library_items_by_type(type)

Returns the list of media library items filtered by type.

Examples

iex> list_media_library_items_by_type("image")
[%CmsMediaLibraryItem{}, ...]

search_media_library_items(query)

Searches media library items by name.

Examples

iex> search_media_library_items("logo")
[%CmsMediaLibraryItem{}, ...]

search_media_library_items(query, type)

Searches media library items by name and type.

Examples

iex> search_media_library_items("logo", "image")
[%CmsMediaLibraryItem{}, ...]

update_media_library_item(media_library_item, attrs)

Updates a media library item.

Examples

iex> update_media_library_item(media_library_item, %{field: new_value})
{:ok, %CmsMediaLibraryItem{}}

iex> update_media_library_item(media_library_item, %{field: bad_value})
{:error, %Ecto.Changeset{}}