View Source Claper.Forms (Claper v1.4.0)
The Forms context.
Link to this section Summary
Functions
Add an empty form field to a form changeset.
Returns an %Ecto.Changeset{}
for tracking form changes.
Returns an %Ecto.Changeset{}
for tracking form submit changes.
Creates a form.
Creates a form submit.
Creates or update a FormSubmit.
Deletes a form.
Deletes a form submit.
Gets a single form.
Gets a single form for a given position.
Gets a single FormSubmit.
Gets a single FormSubmit by its ID.
Returns the list of form submissions for a given presentation file.
Returns the list of forms for a given presentation file.
Returns the list of forms for a given presentation file and a given position.
Remove a form field from a form changeset.
Updates a form.
Link to this section Functions
Add an empty form field to a form changeset.
Returns an %Ecto.Changeset{}
for tracking form changes.
examples
Examples
iex> change_form(form)
%Ecto.Changeset{data: %Form{}}
Returns an %Ecto.Changeset{}
for tracking form submit changes.
examples
Examples
iex> change_form_submit(form_submit)
%Ecto.Changeset{data: %FormSubmit{}}
Creates a form.
examples
Examples
iex> create_form(%{field: value})
{:ok, %Form{}}
iex> create_form(%{field: bad_value})
{:error, %Ecto.Changeset{}}
Creates a form submit.
examples
Examples
iex> create_form_submit(%{field: value})
{:ok, %FormSubmit{}}
iex> create_form_submit(%{field: bad_value})
{:error, %Ecto.Changeset{}}
Creates or update a FormSubmit.
examples
Examples
iex> create_or_update_form_submit(%{field: value})
{:ok, %FormSubmit{}}
iex> create_or_update_form_submit(%{field: bad_value})
{:error, %Ecto.Changeset{}}
Deletes a form.
examples
Examples
iex> delete_form("123e4567-e89b-12d3-a456-426614174000", form)
{:ok, %Form{}}
iex> delete_form("123e4567-e89b-12d3-a456-426614174000", form)
{:error, %Ecto.Changeset{}}
Deletes a form submit.
examples
Examples
iex> delete_form_submit(post, event_id)
{:ok, %FormSubmit{}}
iex> delete_form_submit(post, event_id)
{:error, %Ecto.Changeset{}}
Gets a single form.
Raises Ecto.NoResultsError
if the Form does not exist.
examples
Examples
iex> get_form!(123)
%Poll{}
iex> get_form!(456)
** (Ecto.NoResultsError)
Gets a single form for a given position.
examples
Examples
iex> get_form!(123, 0)
%Form{}
Gets a single FormSubmit.
examples
Examples
iex> get_form_submit!(321, 123)
%FormSubmit{}
Gets a single FormSubmit by its ID.
Raises Ecto.NoResultsError
if the FormSubmit does not exist.
examples
Examples
iex> get_form_submit_by_id!("123e4567-e89b-12d3-a456-426614174000")
%Post{}
iex> get_form_submit_by_id!("123e4567-e89b-12d3-a456-426614174123")
** (Ecto.NoResultsError)
Returns the list of form submissions for a given presentation file.
examples
Examples
iex> list_form_submits(123)
[%FormSubmit{}, ...]
Returns the list of forms for a given presentation file.
examples
Examples
iex> list_forms(123)
[%Form{}, ...]
Returns the list of forms for a given presentation file and a given position.
examples
Examples
iex> list_forms_at_position(123, 0)
[%Form{}, ...]
Remove a form field from a form changeset.
Updates a form.
examples
Examples
iex> update_form("123e4567-e89b-12d3-a456-426614174000", form, %{field: new_value})
{:ok, %Form{}}
iex> update_form("123e4567-e89b-12d3-a456-426614174000", form, %{field: bad_value})
{:error, %Ecto.Changeset{}}