Text.Digestive.Form

End-user interface - provides the main functionality for form creation and validation. For an interface for front-end implementation, see View.

Documentation

type Formlet v m a = Maybe a -> Form v m a

A Form with a set, optional default value

type Form v m a = FormTree m v m a

Base type for a form.

The three type parameters are:

• v: the type for textual information, displayed to the user. For example, error messages are of this type. v stands for "view".
• m: the monad in which validators operate. The classical example is when validating input requires access to a database, in which case this m should be an instance of MonadIO.
• a: the type of the value returned by the form, used for its Applicative instance.

data SomeForm v m

Value-agnostic Form

Constructors

SomeForm (FormTree Identity v m a)

Instances

Show (SomeForm v m)

Defined in Text.Digestive.Form.Internal

Methods

showsPrec :: Int -> SomeForm v m -> ShowS

show :: SomeForm v m -> String

showList :: [SomeForm v m] -> ShowS

(.:) :: Monad m => Text -> Form v m a -> Form v m a infixr 5

Operator to set a name for a subform.

Basic forms

text :: (Monad m, Monoid v) => Formlet v m Text

Returns a Formlet which may optionally take a default text

string :: (Monad m, Monoid v) => Formlet v m String

Identical to "text" but takes a String

stringRead :: (Monad m, Monoid v, Read a, Show a) => v -> Formlet v m a

Returns a Formlet for a parseable and serializable value type

choice :: (Eq a, Monad m, Monoid v) => [(a, v)] -> Formlet v m a

Returns a Formlet for a value restricted to a single value from the provided list of value-message tuples

choice' :: (Monad m, Monoid v) => [(a, v)] -> Maybe Int -> Form v m a

Sometimes there is no good Eq instance for choice. In this case, you can use this function, which takes an index in the list as default.

choiceWith :: (Eq a, Monad m, Monoid v) => [(Text, (a, v))] -> Formlet v m a

Allows you to assign your own values: these values will be used in the resulting HTML instead of the default [0 ..]. This fixes some race conditions that might otherwise appear, e.g. if new choice items are added to some database while a user views and submits the form...

choiceWith' :: (Monad m, Monoid v) => [(Text, (a, v))] -> Maybe Int -> Form v m a

A version of choiceWith for when there is no good Eq instance.

choiceMultiple :: (Eq a, Monad m, Monoid v) => [(a, v)] -> Formlet v m [a]

Returns a Formlet for a value restricted to multiple values from the provided list of value-message tuples. Intended for use with the multiple attribute for select elements. Allows for an empty result.

choiceMultiple' :: (Monad m, Monoid v) => [(a, v)] -> Maybe [Int] -> Form v m [a]

Sometimes there is no good Eq instance for choice. In this case, you can use this function, which takes an index in the list as default.

choiceWithMultiple :: (Eq a, Monad m, Monoid v) => [(Text, (a, v))] -> Formlet v m [a]

Allows you to assign your own values: these values will be used in the resulting HTML instead of the default [0 ..]. This fixes some race conditions that might otherwise appear, e.g. if new choice items are added to some database while a user views and submits the form...

choiceWithMultiple' :: (Monad m, Monoid v) => [(Text, (a, v))] -> Maybe [Int] -> Form v m [a]

A version of choiceWithMultiple for when there is no good Eq instance.

groupedChoice :: (Eq a, Monad m, Monoid v) => [(Text, [(a, v)])] -> Formlet v m a

Returns a Formlet for a single value from named groups of choices.

groupedChoice' :: (Monad m, Monoid v) => [(Text, [(a, v)])] -> Maybe Int -> Form v m a

Sometimes there is no good Eq instance for choice. In this case, you can use this function, which takes an index in the list as default.

groupedChoiceWith :: (Eq a, Monad m, Monoid v) => [(Text, [(Text, (a, v))])] -> Formlet v m a

Allows you to assign your own values: these values will be used in the resulting HTML instead of the default [0 ..]. This fixes some race conditions that might otherwise appear, e.g. if new choice items are added to some database while a user views and submits the form...

groupedChoiceWith' :: (Monad m, Monoid v) => [(Text, [(Text, (a, v))])] -> Maybe Int -> Form v m a

Low-level support for grouped choice.

groupedChoiceMultiple :: (Eq a, Monad m, Monoid v) => [(Text, [(a, v)])] -> Formlet v m [a]

Returns a Formlet for multiple values from named groups of choices. Intended for use with the multiple attribute for select elements that have optgroups. Allows for an empty result.

groupedChoiceMultiple' :: (Monad m, Monoid v) => [(Text, [(a, v)])] -> Maybe [Int] -> Form v m [a]

Sometimes there is no good Eq instance for choice. In this case, you can use this function, which takes an index in the list as default.

groupedChoiceWithMultiple :: (Eq a, Monad m, Monoid v) => [(Text, [(Text, (a, v))])] -> Formlet v m [a]

Allows you to assign your own values: these values will be used in the resulting HTML instead of the default [0 ..]. This fixes some race conditions that might otherwise appear, e.g. if new choice items are added to some database while a user views and submits the form...

groupedChoiceWithMultiple' :: (Monad m, Monoid v) => [(Text, [(Text, (a, v))])] -> Maybe [Int] -> Form v m [a]

Low-level support for grouped choice.

bool :: (Monad m, Monoid v) => Formlet v m Bool

Returns a Formlet for binary choices

file :: (Monad m, Monoid v) => Form v m (Maybe FilePath)

Returns a Formlet for file selection

fileMultiple :: (Monad m, Monoid v) => Form v m [FilePath]

Returns a Formlet for multiple file selection. Intended for use with the multiple attribute, which allows for multiple files to be uploaded with a single input element.

Optional forms

optionalText :: (Monad m, Monoid v) => Maybe Text -> Form v m (Maybe Text)

Create a text form with an optional default text which returns nothing if no optional text was set, and no input was retrieved.

optionalString :: (Monad m, Monoid v) => Maybe String -> Form v m (Maybe String)

Identical to optionalText, but uses Strings

optionalStringRead :: (Monad m, Monoid v, Read a, Show a) => v -> Maybe a -> Form v m (Maybe a)

Identical to optionalText for parseable and serializable values.

Date/time forms

utcTimeFormlet

Arguments

:: Monad m

=> String

Date format string

-> String

Time format string

-> TimeZone

-> Formlet Text m UTCTime

localTimeFormlet

Arguments

:: Monad m

=> String

Date format string

-> String

Time format string

-> Formlet Text m LocalTime

dateFormlet

Arguments

:: Monad m

=> String

Format string

-> Formlet Text m Day

timeFormlet

Arguments

:: Monad m

=> String

Format string

-> Formlet Text m TimeOfDay

optionalUtcTimeFormlet

Arguments

:: Monad m

=> String

Date format string

-> String

Time format string

-> TimeZone

-> Maybe UTCTime

-> Form Text m (Maybe UTCTime)

optionalLocalTimeFormlet

Arguments

:: Monad m

=> String

Date format string

-> String

Time format string

-> Maybe LocalTime

-> Form Text m (Maybe LocalTime)

optionalDateFormlet

Arguments

:: Monad m

=> String

Format string

-> Maybe Day

-> Form Text m (Maybe Day)

optionalTimeFormlet

Arguments

:: Monad m

=> String

Format string

-> Maybe TimeOfDay

-> Form Text m (Maybe TimeOfDay)

Validation and transformation

check

Arguments

:: (Monad m, Monoid v)

=> v

Error message (if fail)

-> (a -> Bool)

Validating predicate

-> Form v m a

Form to validate

-> Form v m a

Resulting form

Validate the results of a form with a simple predicate

Example:

check "Can't be empty" (not . null) (string Nothing)

checkM :: (Monad m, Monoid v) => v -> (a -> m Bool) -> Form v m a -> Form v m a

Version of check which allows monadic validations

validate :: (Monad m, Monoid v) => (a -> Result v b) -> Form v m a -> Form v m b

This is an extension of check that can be used to apply transformations that optionally fail

Example: taking the first character of an input string

head' :: String -> Result String Char
head' []      = Error "Is empty"
head' (x : _) = Success x

char :: Monad m => Form m String Char
char = validate head' (string Nothing)

validateOptional :: (Monad m, Monoid v) => (a -> Result v b) -> Form v m (Maybe a) -> Form v m (Maybe b)

Same as validate, but works with forms of the form:

 Form v m (Maybe a)

.

Example: taking the first character of an optional input string

head' :: String -> Result String Char
head' []      = Error "Is empty"
head' (x : _) = Success x

char :: Monad m => Form m String (Maybe Char)
char = validateOptional head' (optionalString Nothing)

validateM :: (Monad m, Monoid v) => (a -> m (Result v b)) -> Form v m a -> Form v m b

Version of validate which allows monadic validations

conditions

Arguments

:: [a -> Result e b]

Any Success result of a validation function is provably guaranteed to be discarded. Only Error results are used.

-> a

If all validation functions pass, parameter will be re-wrapped with a Success.

-> Result [e] a

List of errors is guaranteed to be in the same order as inputed validations functions. So,

conditions [even,  greaterThan 0] -1

is specified to return

Error ["must be even", "must be greater than 0"]

and not

Error ["must be greater than 0", "must be even"]

.

Allows for the composition of independent validation functions.

For example, let's validate an even integer between 0 and 100:

form :: Monad m => Form Text m FormData
... -- some fields
<*> "smallEvenInteger" .: validate (notEmpty >=> integer >=> even >=> greaterThan 0 >=> lessThanOrEq 100) (text Nothing)
... -- more fields

where

notEmpty       :: IsString v => Text -> Result v Text
integer        :: (Integral a, IsString v) => Text -> Result v a
greaterThan  0 :: (Num a, Ord a, Show a) => a -> Result Text a
lessThanOrEq 0 :: (Num a, Ord a, Show a) => a -> Result Text a
even           :: Integer -> Result Text Integer

.

This will validate our smallEvenInteger correctly, but there is a problem. If a user enters an odd number greater than 100, only

"number must be even"

will be returned. It would make for a better user experience if

["number must be even", "number must be less than 100"]

was returned instead. This can be accomplished by rewriting our form to be:

form :: Monad m => Form [Text] m FormData
... -- some fields
<*> "smallEvenInteger" .: validate (notEmpty >=> integer >=> conditions [even, greaterThan 0, lessThanOrEq 100]) (text Nothing)
... -- more fields

.

If we want to collapse our list of errors into a single Text, we can do something like:

form :: Monad m => Form Text m FormData
... -- some fields
<*> "smallEvenInteger" .: validate (notEmpty >=> integer >=> commaSeperated . conditions [even, greaterThan 0, lessThanOrEq 100]) (text Nothing)
... -- more fields

where

commaSeperated :: (Result [Text] a) -> (Result Text a)

.

disable :: Form v m a -> Form v m a

Disables a form

Lifting forms

monadic :: m (Form v m a) -> Form v m a

Hide a monadic wrapper

Dynamic list forms

listOf :: (Monad m, Monoid v) => (Maybe a -> Form v m b) -> Maybe [a] -> Form v m [b]

Dynamic lists.

The type is a less restrictive version of:

Formlet a -> Formlet [a]