Imagine.CmsPages (imagine_cms v6.3.5)
The CmsPages context.
Link to this section Summary
Functions
Returns an %Ecto.Changeset{}
for tracking cms_page changes.
Returns an %Ecto.Changeset{}
for tracking cms_page_tag changes.
Creates a cms_page.
Creates a cms_page_object.
Creates a cms_page_tag.
Creates a cms_page_version.
Deletes a CmsPage.
Deletes a CmsPageTag.
Gets a single cms_page.
Gets a single cms_page_object.
Gets a single cms_page_tag.
Gets a single cms_page_version.
Returns the list of cms_page_objects.
Returns the list of cms_page_tags.
Returns the list of cms_page_versions.
Returns the list of cms_pages.
Updates a cms_page, optionally creating a new version (third argument). When creating a new version, the fourth argument should be the Imagine.Accounts.User who made the change.
Updates a cms_page_object.
Updates a cms_page_tag.
Link to this section Functions
active_pages_query()
active_versions_query()
build_cms_page_object(arg1, obj_name, obj_type)
build_cms_page_object(cms_page_id, cms_page_version, obj_name, obj_type)
change_cms_page(cms_page)
Returns an %Ecto.Changeset{}
for tracking cms_page changes.
Examples
iex> change_cms_page(cms_page)
%Ecto.Changeset{source: %CmsPage{}}
change_cms_page_tag(cms_page_tag)
Returns an %Ecto.Changeset{}
for tracking cms_page_tag changes.
Examples
iex> change_cms_page_tag(cms_page_tag)
%Ecto.Changeset{source: %CmsPageTag{}}
clone_and_update_cms_page_object(cms_page_object, attrs)
create_cms_page(attrs, current_user, iteration \\ 0)
Creates a cms_page.
Examples
iex> create_cms_page(%{field: value})
{:ok, %CmsPage{}}
iex> create_cms_page(%{field: bad_value})
{:error, %Ecto.Changeset{}}
create_cms_page_object(cms_page, attrs \\ %{})
Creates a cms_page_object.
Examples
iex> create_cms_page_object(%{field: value})
{:ok, %CmsPageObject{}}
iex> create_cms_page_object(%{field: bad_value})
{:error, %Ecto.Changeset{}}
create_cms_page_tag(attrs)
Creates a cms_page_tag.
Examples
iex> create_cms_page_tag(%{field: value})
{:ok, %CmsPageTag{}}
iex> create_cms_page_tag(%{field: bad_value})
{:error, %Ecto.Changeset{}}
create_cms_page_version(cms_page)
Creates a cms_page_version.
Examples
iex> create_cms_page_version(%{field: value})
{:ok, %CmsPageVersion{}}
iex> create_cms_page_version(%{field: bad_value})
{:error, %Ecto.Changeset{}}
delete_cms_page(cms_page)
Deletes a CmsPage.
Examples
iex> delete_cms_page(cms_page)
{:ok, %CmsPage{}}
iex> delete_cms_page(cms_page)
{:error, %Ecto.Changeset{}}
delete_cms_page_tag(cms_page_tag)
Deletes a CmsPageTag.
Examples
iex> delete_cms_page_tag(cms_page_tag)
{:ok, %CmsPageTag{}}
iex> delete_cms_page_tag(cms_page_tag)
{:error, %Ecto.Changeset{}}
delete_cms_page_version(cms_page_version)
destroy_cms_page(cms_page)
discarded_pages_query()
get_cms_page(id)
get_cms_page(id, list)
get_cms_page!(id)
Gets a single cms_page.
Raises Ecto.NoResultsError
if the Cms page does not exist.
Examples
iex> get_cms_page!(123)
%CmsPage{}
iex> get_cms_page!(456)
** (Ecto.NoResultsError)
get_cms_page!(id, opts)
get_cms_page_by_path(path)
get_cms_page_by_path_with_objects(path, version \\ nil)
get_cms_page_object!(id)
Gets a single cms_page_object.
Raises Ecto.NoResultsError
if the Cms page object does not exist.
Examples
iex> get_cms_page_object!(123)
%CmsPageObject{}
iex> get_cms_page_object!(456)
** (Ecto.NoResultsError)
get_cms_page_tag!(id)
Gets a single cms_page_tag.
Raises Ecto.NoResultsError
if the Cms page tag does not exist.
Examples
iex> get_cms_page_tag!(123)
%CmsPageTag{}
iex> get_cms_page_tag!(456)
** (Ecto.NoResultsError)
get_cms_page_version!(id)
Gets a single cms_page_version.
Raises Ecto.NoResultsError
if the Cms page version does not exist.
Examples
iex> get_cms_page_version!(123)
%CmsPageVersion{}
iex> get_cms_page_version!(456)
** (Ecto.NoResultsError)
get_cms_page_version_by(params)
get_cms_page_version_by(cms_page, params)
get_cms_page_with_objects!(id, version \\ nil)
get_home_page!()
get_home_page_version_by(params)
get_trash_page()
list_cms_page_objects()
Returns the list of cms_page_objects.
Examples
iex> list_cms_page_objects()
[%CmsPageObject{}, ...]
list_cms_page_tags()
Returns the list of cms_page_tags.
Examples
iex> list_cms_page_tags()
[%CmsPageTag{}, ...]
list_cms_page_versions()
Returns the list of cms_page_versions.
Examples
iex> list_cms_page_versions()
[%CmsPageVersion{}, ...]
list_cms_pages(order_by \\ [asc: :path], limit \\ 1000)
Returns the list of cms_pages.
Examples
iex> list_cms_pages()
[%CmsPage{}, ...]
list_discarded_cms_pages()
list_recent_cms_pages(limit \\ 10)
preload_objects_and_versions(page_or_version)
undelete_cms_page(cms_page)
update_cms_page(cms_page, attrs, save_new_version \\ false, current_user \\ nil)
Updates a cms_page, optionally creating a new version (third argument). When creating a new version, the fourth argument should be the Imagine.Accounts.User who made the change.
Examples
iex> update_cms_page(cms_page, %{field: new_value})
{:ok, %CmsPage{}}
iex> update_cms_page(cms_page, %{field: bad_value}, true, current_user)
{:error, %Ecto.Changeset{}}
update_cms_page_object(cms_page_object, attrs)
Updates a cms_page_object.
Examples
iex> update_cms_page_object(cms_page_object, %{field: new_value})
{:ok, %CmsPageObject{}}
iex> update_cms_page_object(cms_page_object, %{field: bad_value})
{:error, %Ecto.Changeset{}}
update_cms_page_objects(list1, list2, new_version)
update_cms_page_tag(cms_page_tag, attrs)
Updates a cms_page_tag.
Examples
iex> update_cms_page_tag(cms_page_tag, %{field: new_value})
{:ok, %CmsPageTag{}}
iex> update_cms_page_tag(cms_page_tag, %{field: bad_value})
{:error, %Ecto.Changeset{}}