Formex v0.6.7 Formex.Form

t() :: %Formex.Form{errors: term, items: term, mapped_params: term, method: term, new_struct: term, opts: term, params: term, phoenix_form: term, struct: term, struct_info: term, struct_module: term, submitted?: term, template: term, template_options: term, type: term, valid?: term}

Functions

__struct__()

Defines the Formex.Form struct.

:type - the module that implements Formex.Type, for example: App.ArticleType
:struct - the struct of your data, for example: %App.Article{}
:new_struct - the :struct with :params applied
:struct_module - struct.__struct__, for example: App.Article
:struct_info - additional info about struct, that can differs between implementations of Formex.BuilderProtocol
:items - list of Formex.Field, Formex.Button, Formex.FormCollection and Formex.FormNested structs
:params - sent parameters, passed by Plug.Conn
:mapped_params - :params prepared to create a :new_struct or to create a changeset by Formex.Ecto
:phoenix_form - %Phoenix.HTML.Form{}
:template - the module that implements Formex.Template, for example: Formex.Template.BootstrapHorizontal. Can be set via a Formex.View.formex_form_for options
:template_options
:method - :post, :put etc. May be used by Formex.View. E.g. Formex.Ecto.Builder sets here :put if we editing struct, :post otherwise.
:submitted? - is form submitted? Set by Formex.Controller.handle_form/1
:opts - additional data passed in a controller. See: Formex.Builder.create_form/5
:valid?
:errors

find(form, name)

find(form :: t, name :: atom) :: list

Finds form item by name

find_by_struct_name(form, name)

find_by_struct_name(form :: t, name :: atom) :: list

Finds form item by struct name

get_collections(form)

get_collections(form :: t) :: list

Returns list of Formex.FormCollection.t/0

get_fields(form)

get_fields(form :: t) :: list

Returns list of Formex.Field.t/0

get_fields_controllable(form)

get_fields_controllable(form :: t) :: list

Returns list of items which user can control (all except the Button)

get_fields_validatable(form)

get_fields_validatable(form :: t) :: list

Returns list of items which can be validated (alias for get_fields_controllable/1)

get_items_with_changed_name(form)

get_items_with_changed_name(form :: t) :: list

Returns list of names of items with changed name (item.name != item.struct_name)

get_name_by_struct_name(form, struct_name)

get_name_by_struct_name(form :: t, struct_name :: atom) :: atom

Finds form item by struct_name and returns name

get_nested(form)

get_nested(form :: t) :: list

Returns list of Formex.FormNested.t/0

get_struct_name_by_name(form, name)

get_struct_name_by_name(form :: t, name :: atom) :: atom

Finds form item by name and returns struct_name

get_subforms(form)

get_subforms(form :: t) :: list

Returns list of Formex.FormNested.t/0 and Formex.FormCollection.t/0

is_controllable(item)

is_controllable(item :: any) :: boolean

Is controllable (all except the Button)

put_item(form, item)

put_item(form :: t, item :: any) :: t

Adds field to the form. More: Formex.Field.create_field/4, Button.create_button/3