Yesod.Form

Parse forms (and query strings).

Data types

newtype GForm sub y xml a

A generic form, allowing you to specifying the subsite datatype, master site datatype, a datatype for the form XML and the return type.

Constructors

GForm

Fields

deform :: Env -> FileEnv -> StateT Int (GHandler sub y) (FormResult a, xml, Enctype)

Instances

Monoid xml => Functor (GForm sub url xml)

Monoid xml => Applicative (GForm sub url xml)

type Form sub y = GForm sub y (GWidget sub y ())

type Formlet sub y a = Maybe a -> Form sub y a

type FormField sub y = GForm sub y [FieldInfo sub y]

type FormletField sub y a = Maybe a -> FormField sub y a

type FormInput sub y = GForm sub y [GWidget sub y ()]

data FormResult a

A form can produce three different results: there was no data available, the data was invalid, or there was a successful parse.

The Applicative instance will concatenate the failure messages in two FormResults.

Constructors

FormMissing

FormFailure [String]

FormSuccess a

Instances

Functor FormResult

Applicative FormResult

Show a => Show (FormResult a)

data Enctype

The encoding type required by a form. The Show instance produces values that can be inserted directly into HTML.

Constructors

UrlEncoded

Multipart

Instances

Show Enctype

Monoid Enctype

data FieldInfo sub y

Using this as the intermediate XML representation for fields allows us to write generic field functions and then different functions for producing actual HTML. See, for example, fieldsToTable and fieldsToPlain.

Constructors

FieldInfo

Fields

fiLabel :: Html ()

fiTooltip :: Html ()

fiIdent :: String

fiInput :: GWidget sub y ()

fiErrors :: Maybe (Html ())

Newtype wrappers

newtype JqueryDay

A newtype wrapper around Day, using jQuery UI date picker for the ToFormField instance.

Constructors

JqueryDay

Fields

unJqueryDay :: Day

Instances

PersistField JqueryDay

ToFormField JqueryDay

ToFormField (Maybe JqueryDay)

newtype NicHtml

Constructors

NicHtml

Fields

unNicHtml :: Html ()

Instances

PersistField NicHtml

ToFormField NicHtml

ToFormField (Maybe NicHtml)

type Html' = Html ()

Unwrapping functions

runFormGet :: GForm sub y xml a -> GHandler sub y (FormResult a, xml, Enctype)

Run a form against GET parameters.

runFormPost :: GForm sub y xml a -> GHandler sub y (FormResult a, xml, Enctype)

Run a form against POST parameters.

runFormGet' :: GForm sub y xml a -> GHandler sub y a

Run a form against GET parameters, disregarding the resulting HTML and returning an error response on invalid input.

runFormPost' :: GForm sub y xml a -> GHandler sub y a

Run a form against POST parameters, disregarding the resulting HTML and returning an error response on invalid input.

Type classes

class ToForm a where

Methods

toForm :: Maybe a -> Form sub y a

class ToFormField a where

Methods

toFormField :: Html () -> Html () -> Maybe a -> FormField sub y a

Instances

ToFormField Bool

ToFormField Double

ToFormField Int

ToFormField Int64

ToFormField String

ToFormField TimeOfDay

ToFormField Day

ToFormField NicHtml

ToFormField JqueryDay

ToFormField (Maybe Double)

ToFormField (Maybe Int)

ToFormField (Maybe Int64)

ToFormField (Maybe String)

ToFormField (Maybe (Html ()))

ToFormField (Maybe TimeOfDay)

ToFormField (Maybe Day)

ToFormField (Maybe NicHtml)

ToFormField (Maybe JqueryDay)

ToFormField (Html ())

Field/form helpers

requiredFieldHelper :: FieldProfile sub y a -> Maybe a -> FormField sub y a

Create a required field (ie, one that cannot be blank) from a FieldProfile.

optionalFieldHelper :: FieldProfile sub y a -> Maybe (Maybe a) -> FormField sub y (Maybe a)

Create an optional field (ie, one that can be blank) from a FieldProfile.

mapFormXml :: (xml1 -> xml2) -> GForm s y xml1 a -> GForm s y xml2 a

Convert the XML in a GForm.

newFormIdent :: Monad m => StateT Int m String

Get a unique identifier.

fieldsToTable :: [FieldInfo sub y] -> GWidget sub y ()

Display the label, tooltip, input code and errors in a single row of a table.

fieldsToPlain :: [FieldInfo sub y] -> GWidget sub y ()

Display only the actual input widget code, without any decoration.

fieldsToInput :: [FieldInfo sub y] -> [GWidget sub y ()]

Field profiles

data FieldProfile sub y a

A generic definition of a form field that can be used for generating both required and optional fields. See 'requiredFieldHelper and optionalFieldHelper.

Constructors

FieldProfile

Fields

fpParse :: String -> Either String a

fpRender :: a -> String

fpHamlet :: Html () -> Html () -> Bool -> Hamlet (Route y)

fpWidget :: String -> GWidget sub y ()

fpName :: Maybe String

fpLabel :: Html ()

fpTooltip :: Html ()

stringFieldProfile :: FieldProfile sub y String

intFieldProfile :: Integral i => FieldProfile sub y i

dayFieldProfile :: FieldProfile sub y Day

jqueryDayFieldProfile :: FieldProfile sub y Day

timeFieldProfile :: FieldProfile sub y TimeOfDay

htmlFieldProfile :: FieldProfile sub y (Html ())

emailFieldProfile :: FieldProfile s y String

Pre-built fields

stringField :: Html () -> Html () -> FormletField sub y String

maybeStringField :: Html () -> Html () -> FormletField sub y (Maybe String)

intField :: Integral i => Html () -> Html () -> FormletField sub y i

maybeIntField :: Integral i => Html () -> Html () -> FormletField sub y (Maybe i)

doubleField :: Html () -> Html () -> FormletField sub y Double

maybeDoubleField :: Html () -> Html () -> FormletField sub y (Maybe Double)

dayField :: Html () -> Html () -> FormletField sub y Day

maybeDayField :: Html () -> Html () -> FormletField sub y (Maybe Day)

jqueryDayField :: Html () -> Html () -> FormletField sub y Day

maybeJqueryDayField :: Html () -> Html () -> FormletField sub y (Maybe Day)

timeField :: Html () -> Html () -> FormletField sub y TimeOfDay

maybeTimeField :: Html () -> Html () -> FormletField sub y (Maybe TimeOfDay)

htmlField :: Html () -> Html () -> FormletField sub y (Html ())

maybeHtmlField :: Html () -> Html () -> FormletField sub y (Maybe (Html ()))

nicHtmlField :: Html () -> Html () -> FormletField sub y (Html ())

maybeNicHtmlField :: Html () -> Html () -> FormletField sub y (Maybe (Html ()))

selectField :: Eq x => [(x, String)] -> Html () -> Html () -> Maybe x -> FormField sub master x

maybeSelectField :: Eq x => [(x, String)] -> Html () -> Html () -> Maybe x -> FormField sub master (Maybe x)

boolField :: Html () -> Html () -> Maybe Bool -> FormField sub y Bool

jqueryAutocompleteField :: Route y -> Html () -> Html () -> FormletField sub y String

maybeJqueryAutocompleteField :: Route y -> Html () -> Html () -> FormletField sub y (Maybe String)

emailField :: Html () -> Html () -> FormletField sub y String

maybeEmailField :: Html () -> Html () -> FormletField sub y (Maybe String)

Pre-built inputs

stringInput :: String -> FormInput sub master String

maybeStringInput :: String -> FormInput sub master (Maybe String)

boolInput :: String -> FormInput sub master Bool

dayInput :: String -> FormInput sub master Day

maybeDayInput :: String -> FormInput sub master (Maybe Day)

emailInput :: String -> FormInput sub master String

Template Haskell

share2 :: Monad m => (a -> m [b]) -> (a -> m [b]) -> a -> m [b]

This function allows two different monadic functions to share the same input and have their results concatenated. This is particularly useful for allowing mkToForm to share its input with mkPersist.

mkToForm :: [EntityDef] -> Q [Dec]

Create ToForm instances for the entities given. In addition to regular EntityDef attributes understood by persistent, it also understands label= and tooltip=.