Safe Haskell | Safe-Infered |
---|
Yesod.Form.Functions
Contents
- newFormIdent :: MForm sub master Text
- askParams :: MForm sub master (Maybe Env)
- askFiles :: MForm sub master (Maybe FileEnv)
- formToAForm :: MForm sub master (FormResult a, [FieldView sub master]) -> AForm sub master a
- aFormToForm :: AForm sub master a -> MForm sub master (FormResult a, [FieldView sub master] -> [FieldView sub master])
- mreq :: RenderMessage master FormMessage => Field sub master a -> FieldSettings master -> Maybe a -> MForm sub master (FormResult a, FieldView sub master)
- mopt :: Field sub master a -> FieldSettings master -> Maybe (Maybe a) -> MForm sub master (FormResult (Maybe a), FieldView sub master)
- areq :: RenderMessage master FormMessage => Field sub master a -> FieldSettings master -> Maybe a -> AForm sub master a
- aopt :: Field sub master a -> FieldSettings master -> Maybe (Maybe a) -> AForm sub master (Maybe a)
- runFormPost :: RenderMessage master FormMessage => (Markup -> MForm sub master (FormResult a, xml)) -> GHandler sub master ((FormResult a, xml), Enctype)
- runFormPostNoToken :: (Markup -> MForm sub master (FormResult a, xml)) -> GHandler sub master ((FormResult a, xml), Enctype)
- runFormGet :: (Markup -> MForm sub master a) -> GHandler sub master (a, Enctype)
- generateFormPost :: RenderMessage master FormMessage => (Markup -> MForm sub master (FormResult a, xml)) -> GHandler sub master (xml, Enctype)
- generateFormGet :: (Markup -> MForm sub master a) -> GHandler sub master (a, Enctype)
- type FormRender sub master a = AForm sub master a -> Markup -> MForm sub master (FormResult a, GWidget sub master ())
- renderTable, renderDivs :: FormRender sub master a
- renderBootstrap :: FormRender sub master a
- check :: RenderMessage master msg => (a -> Either msg a) -> Field sub master a -> Field sub master a
- checkBool :: RenderMessage master msg => (a -> Bool) -> msg -> Field sub master a -> Field sub master a
- checkM :: RenderMessage master msg => (a -> GHandler sub master (Either msg a)) -> Field sub master a -> Field sub master a
- customErrorMessage :: SomeMessage master -> Field sub master a -> Field sub master a
- fieldSettingsLabel :: RenderMessage master msg => msg -> FieldSettings master
- aformM :: GHandler sub master a -> AForm sub master a
Running in MForm monad
newFormIdent :: MForm sub master Text
Get a unique identifier.
Applicative/Monadic conversion
formToAForm :: MForm sub master (FormResult a, [FieldView sub master]) -> AForm sub master a
aFormToForm :: AForm sub master a -> MForm sub master (FormResult a, [FieldView sub master] -> [FieldView sub master])
Fields to Forms
mreq :: RenderMessage master FormMessage => Field sub master a -> FieldSettings master -> Maybe a -> MForm sub master (FormResult a, FieldView sub master)
mopt :: Field sub master a -> FieldSettings master -> Maybe (Maybe a) -> MForm sub master (FormResult (Maybe a), FieldView sub master)
areq :: RenderMessage master FormMessage => Field sub master a -> FieldSettings master -> Maybe a -> AForm sub master a
Run a form
runFormPost :: RenderMessage master FormMessage => (Markup -> MForm sub master (FormResult a, xml)) -> GHandler sub master ((FormResult a, xml), Enctype)
This function is used to both initially render a form and to later extract results from it. Note that, due to CSRF protection and a few other issues, forms submitted via GET and POST are slightly different. As such, be sure to call the relevant function based on how the form will be submitted, not the current request method.
For example, a common case is displaying a form on a GET request and having
the form submit to a POST page. In such a case, both the GET and POST
handlers should use runFormPost
.
runFormPostNoToken :: (Markup -> MForm sub master (FormResult a, xml)) -> GHandler sub master ((FormResult a, xml), Enctype)
runFormGet :: (Markup -> MForm sub master a) -> GHandler sub master (a, Enctype)
Generate a blank form
generateFormPost :: RenderMessage master FormMessage => (Markup -> MForm sub master (FormResult a, xml)) -> GHandler sub master (xml, Enctype)
Similar to runFormPost
, except it always ignore the currently available
environment. This is necessary in cases like a wizard UI, where a single
page will both receive and incoming form and produce a new, blank form. For
general usage, you can stick with runFormPost
.
generateFormGet :: (Markup -> MForm sub master a) -> GHandler sub master (a, Enctype)
Rendering
type FormRender sub master a = AForm sub master a -> Markup -> MForm sub master (FormResult a, GWidget sub master ())
renderTable, renderDivs :: FormRender sub master a
renderBootstrap :: FormRender sub master a
Render a form using Bootstrap-friendly shamlet syntax.
Sample Hamlet:
<form .form-horizontal method=post action=@{ActionR} enctype=#{formEnctype}> <fieldset> <legend>_{MsgLegend} $case result $of FormFailure reasons $forall reason <- reasons <div .alert .alert-error>#{reason} $of _ ^{formWidget} <div .form-actions> <input .btn .primary type=submit value=_{MsgSubmit}>
Validation
check :: RenderMessage master msg => (a -> Either msg a) -> Field sub master a -> Field sub master a
checkBool :: RenderMessage master msg => (a -> Bool) -> msg -> Field sub master a -> Field sub master a
Return the given error message if the predicate is false.
checkM :: RenderMessage master msg => (a -> GHandler sub master (Either msg a)) -> Field sub master a -> Field sub master a
customErrorMessage :: SomeMessage master -> Field sub master a -> Field sub master a
Allows you to overwrite the error message on parse error.
Utilities
fieldSettingsLabel :: RenderMessage master msg => msg -> FieldSettings master
Generate a FieldSettings
from the given label.