Safe Haskell	None
Language	Haskell2010

Yesod.Filter.TH

Synopsis

mkFilterGenerator :: Text -> Options -> DecsQ
mkFilters :: ExpQ
mkSelectOpts :: ExpQ
data Options = Options {
- filtering :: Filtering
- sorting :: Sorting
- pagination :: Pagination
}
data Filtering
- = SimpleFiltering {
  - filterDefs :: [FilterDef]
  }
- | NoFiltering
data FilterDef = FilterDef Text [FilterParam]
data FilterParam
- = AutoParam FilterOp
- | CustomParam FilterOp Text
data FilterOp
- = EqOp
- | NeOp
- | GtOp
- | LtOp
- | GeOp
- | LeOp
- | IsNullOp
data Sorting
- = AllowSorting {
  - sortParam :: Text
  - sortFields :: [Text]
  - defaultOrdering :: SortOrdering
  }
- | DisallowSorting
data SortOrdering
- = NaturalOrdering
- | ORDERBY Text SortDirection
data SortDirection
- = ASC
- | DESC
data Pagination
- = OffsetPagination {
  - offsetParam :: Text
  - defaultOffset :: PageOffset
  - limitParam :: Text
  - defaultLimit :: PageLimit
  }
- | NoPagination
data PageLimit
- = NoLimit
- | LIMIT Int
data PageOffset
- = NoOffset
- | OFFSET Int
defaultOptions :: Options
defaultFiltering :: Filtering
defaultFilterParams :: [FilterParam]
defaultSorting :: Sorting
defaultPagination :: Pagination
mkToFilterValueInstances :: Text -> DecsQ
availableFiltersE :: Text -> Filtering -> ExpQ
defaultOrderByE :: Text -> Sorting -> ExpQ
availableOrderBysE :: Text -> Sorting -> ExpQ

Documentation

mkFilterGenerator :: Text -> Options -> DecsQ Source #

Generates the function that creates the list of Filter and the list of SelectOpt from query parameters.

mkFilters :: ExpQ Source #

Generates the list of Filter.

mkSelectOpts :: ExpQ Source #

Generates the list of SelectOpt.

data Options Source #

Options to specify filtering, sorting, and pagination settings to generate.

Constructors

Options
Fields filtering :: Filtering sorting :: Sorting pagination :: Pagination

Instances

Show Options Source #
Instance details Defined in Yesod.Filter.Types Methods showsPrec :: Int -> Options -> ShowS # show :: Options -> String # showList :: [Options] -> ShowS #
Lift Options Source #
Instance details Defined in Yesod.Filter.Types Methods lift :: Options -> Q Exp #

data Filtering Source #

A filtering setting.

Constructors

SimpleFiltering	Allow users to specify filtering by query parameters.
Fields filterDefs :: [FilterDef]
NoFiltering	Disable filtering.

Instances

Show Filtering Source #
Instance details Defined in Yesod.Filter.Types Methods showsPrec :: Int -> Filtering -> ShowS # show :: Filtering -> String # showList :: [Filtering] -> ShowS #
Lift Filtering Source #
Instance details Defined in Yesod.Filter.Types Methods lift :: Filtering -> Q Exp #

data FilterDef Source #

A filter defintion.

Constructors

FilterDef
Fields Text A field name used for the filter. [FilterParam] Parameters used to specify the filter.

Instances

Show FilterDef Source #
Instance details Defined in Yesod.Filter.Types Methods showsPrec :: Int -> FilterDef -> ShowS # show :: FilterDef -> String # showList :: [FilterDef] -> ShowS #
Lift FilterDef Source #
Instance details Defined in Yesod.Filter.Types Methods lift :: FilterDef -> Q Exp #

data FilterParam Source #

A parameter name used to specify the filter.

Constructors

AutoParam FilterOp	Use automatically generated parameter names.
CustomParam FilterOp Text	Use custom parameter name.

Instances

Show FilterParam Source #
Instance details Defined in Yesod.Filter.Types Methods showsPrec :: Int -> FilterParam -> ShowS # show :: FilterParam -> String # showList :: [FilterParam] -> ShowS #
Lift FilterParam Source #
Instance details Defined in Yesod.Filter.Types Methods lift :: FilterParam -> Q Exp #

data FilterOp Source #

A comparison operator to apply to the filter.

Constructors

EqOp	=
NeOp	<>
GtOp	>
LtOp	<
GeOp	>=
LeOp	<=
IsNullOp	IS NULL

Instances

Show FilterOp Source #
Instance details Defined in Yesod.Filter.Types Methods showsPrec :: Int -> FilterOp -> ShowS # show :: FilterOp -> String # showList :: [FilterOp] -> ShowS #
Lift FilterOp Source #
Instance details Defined in Yesod.Filter.Types Methods lift :: FilterOp -> Q Exp #

data Sorting Source #

A sorting setting.

Constructors

AllowSorting	Allow users to specify sort order by query parameters.
Fields sortParam :: Text A parameter name to specify the field name as a sort key. sortFields :: [Text] Field names that can be used as sort keys. defaultOrdering :: SortOrdering A default order setting.
DisallowSorting	Disable sorting.

Instances

Show Sorting Source #
Instance details Defined in Yesod.Filter.Types Methods showsPrec :: Int -> Sorting -> ShowS # show :: Sorting -> String # showList :: [Sorting] -> ShowS #
Lift Sorting Source #
Instance details Defined in Yesod.Filter.Types Methods lift :: Sorting -> Q Exp #

data SortOrdering Source #

A value that becomes the SQL ORDER BY clause.

Constructors

NaturalOrdering
ORDERBY Text SortDirection

Instances

Show SortOrdering Source #
Instance details Defined in Yesod.Filter.Types Methods showsPrec :: Int -> SortOrdering -> ShowS # show :: SortOrdering -> String # showList :: [SortOrdering] -> ShowS #
Lift SortOrdering Source #
Instance details Defined in Yesod.Filter.Types Methods lift :: SortOrdering -> Q Exp #

data SortDirection Source #

Constructors

ASC
DESC

Instances

Show SortDirection Source #
Instance details Defined in Yesod.Filter.Types Methods showsPrec :: Int -> SortDirection -> ShowS # show :: SortDirection -> String # showList :: [SortDirection] -> ShowS #
Lift SortDirection Source #
Instance details Defined in Yesod.Filter.Types Methods lift :: SortDirection -> Q Exp #

data Pagination Source #

A pagination setting. Currently, only offset pagination is available.

Constructors

OffsetPagination	Allow users to specify offset pagination by query parameters.
Fields offsetParam :: Text A parameter name to specify the offset value. defaultOffset :: PageOffset A default offset setting. limitParam :: Text A parameter name to specify the limit value. defaultLimit :: PageLimit A default limit setting.
NoPagination	Disable pagination.

data PageLimit Source #

A value that becomes the SQL LIMIT clause.

Constructors

NoLimit
LIMIT Int

Instances

Show PageLimit Source #
Instance details Defined in Yesod.Filter.Types Methods showsPrec :: Int -> PageLimit -> ShowS # show :: PageLimit -> String # showList :: [PageLimit] -> ShowS #
Lift PageLimit Source #
Instance details Defined in Yesod.Filter.Types Methods lift :: PageLimit -> Q Exp #

data PageOffset Source #

A value that becomes the SQL OFFSET clause.

Constructors

NoOffset
OFFSET Int

Instances

Show PageOffset Source #
Instance details Defined in Yesod.Filter.Types Methods showsPrec :: Int -> PageOffset -> ShowS # show :: PageOffset -> String # showList :: [PageOffset] -> ShowS #
Lift PageOffset Source #
Instance details Defined in Yesod.Filter.Types Methods lift :: PageOffset -> Q Exp #

defaultOptions :: Options Source #

Default options.

defaultFiltering :: Filtering Source #

A default filtering setting.

defaultFilterParams :: [FilterParam] Source #

Default filter parameters.

defaultSorting :: Sorting Source #

A default sorting setting.

defaultPagination :: Pagination Source #

A default pagination setting.

mkToFilterValueInstances :: Text -> DecsQ Source #

availableFiltersE :: Text -> Filtering -> ExpQ Source #

defaultOrderByE :: Text -> Sorting -> ExpQ Source #

availableOrderBysE :: Text -> Sorting -> ExpQ Source #

Show Pagination Source #
Instance details Defined in Yesod.Filter.Types Methods showsPrec :: Int -> Pagination -> ShowS # show :: Pagination -> String # showList :: [Pagination] -> ShowS #
Lift Pagination Source #
Instance details Defined in Yesod.Filter.Types Methods lift :: Pagination -> Q Exp #