Text.Digestive.View

Provides functionality for frontend and backend integration.

This module contains functions used to glue form handling to particular server implementations and view libraries, defining the standard behaviour for handling GET and POST requests.

Field accessors can be used to write frontend libraries, mapping field values to concrete elements.

Documentation

data View v

Finalized form - handles the form, error messages and input. Internally handles the addressing of individual fields.

Constructors

Monad m => View

Fields

• viewName :: Text
• viewContext :: Path
• viewForm :: FormTree Identity v m a
• viewInput :: [(Path, FormInput)]
• viewErrors :: [(Path, v)]
• viewMethod :: Method

Instances

Functor View

Defined in Text.Digestive.View

Methods

fmap :: (a -> b) -> View a -> View b

(<$) :: a -> View b -> View a

Show v => Show (View v)

Defined in Text.Digestive.View

Methods

showsPrec :: Int -> View v -> ShowS

show :: View v -> String

showList :: [View v] -> ShowS

Obtaining a view

getForm :: Monad m => Text -> Form v m a -> m (View v)

Serve up a form for a GET request - no form input

postForm :: Monad m => Text -> Form v m a -> (FormEncType -> m (Env m)) -> m (View v, Maybe a)

Handle a form for a POST request - evaluate with the given environment and return the result.

Operations on views

subView :: Text -> View v -> View v

Returns the subview of a view matching the given serialized Path

subViews :: View v -> [View v]

Returns all immediate subviews of a view

Querying a view

Low-level

absolutePath :: Text -> View v -> Path

Determine an absolute Path for a field in the form

absoluteRef :: Text -> View v -> Text

Determine an absolute path and call fromPath on it. Useful if you're writing a view library...

Form encoding

viewEncType :: View v -> FormEncType

Returns the content type of the View - depends on contained fields

Input

fieldInputText :: forall v. Text -> View v -> Text

Return the text data at the position referred to by the given serialized Path.

fieldInputChoice :: forall v. Text -> View v -> [(Text, v, Bool)]

Returns a list of (identifier, view, selected?)

fieldInputChoiceGroup :: forall v. Text -> View v -> [(Text, [(Text, v, Bool)])]

Returns a list of (groupName, [(identifier, view, selected?)])

fieldInputBool :: forall v. Text -> View v -> Bool

Returns True/False based on the field referred to by the given serialized Path.

fieldInputFile :: forall v. Text -> View v -> [FilePath]

Return the FilePath referred to by the given serialized path, if set.

List subview

listSubViews :: Text -> View v -> [View v]

Returns sub views referred to by dynamic list indices at the given serialized path.

makeListSubView

Arguments

:: Text

ref

-> Int

index to use for the subview

-> View v

list view

-> View v

Creates a sub view

Errors

errors :: Text -> View v -> [v]

Returns all errors related to the form corresponding to the given serialized Path

childErrors :: Text -> View v -> [v]

Returns all errors related to the form, and its children, pointed to by the given serialized Path.

Further metadata queries

viewDisabled :: Text -> View v -> Bool

Debugging

debugViewPaths :: Monoid v => View v -> [Path]

Retrieve all paths of the contained form