Safe Haskell	None

IHP.ControllerSupport

Synopsis

type Action' = IO ResponseReceived
(|>) :: t1 -> (t1 -> t2) -> t2
getRequestBody :: (?requestContext :: RequestContext) => IO ByteString
getRequestPath :: (?requestContext :: RequestContext) => ByteString
getRequestPathAndQuery :: (?requestContext :: RequestContext) => ByteString
getHeader :: (?requestContext :: RequestContext) => ByteString -> Maybe ByteString
data RequestContext = RequestContext Request Respond [Param] [File ByteString] (Key (Session IO String String))
request :: (?requestContext :: RequestContext) => Request
requestHeaders :: Request -> RequestHeaders
getFiles :: (?requestContext :: RequestContext) => [File ByteString]
class (Show controller, Eq controller) => Controller controller where
- beforeAction :: (?controllerContext :: ControllerContext, ?modelContext :: ModelContext, ?requestContext :: RequestContext, ?theAction :: controller) => IO ()
- action :: (?controllerContext :: ControllerContext, ?modelContext :: ModelContext, ?requestContext :: RequestContext, ?theAction :: controller) => controller -> IO ()
runAction :: forall controller. (Controller controller, ?requestContext :: RequestContext, ?controllerContext :: ControllerContext, ?modelContext :: ModelContext, FrameworkConfig) => controller -> IO ResponseReceived
createRequestContext :: ApplicationContext -> Request -> Respond -> IO RequestContext
data ControllerContext
fromControllerContext :: forall a. (?controllerContext :: ControllerContext, Typeable a) => a
maybeFromControllerContext :: forall a. (?controllerContext :: ControllerContext, Typeable a) => Maybe a
class InitControllerContext application where
- initContext :: (?modelContext :: ModelContext, ?requestContext :: RequestContext, ?applicationContext :: ApplicationContext) => TMap -> IO TMap
runActionWithNewContext :: forall application controller. (Controller controller, ?applicationContext :: ApplicationContext, ?requestContext :: RequestContext, InitControllerContext application, ?application :: application, Typeable application, Typeable controller, FrameworkConfig) => controller -> IO ResponseReceived
emptyControllerContext :: ControllerContext
respondAndExit :: Response -> IO ()
newtype ActionType = ActionType TypeRep
data ResponseException = ResponseException Response

Documentation

type Action' = IO ResponseReceived Source #

(|>) :: t1 -> (t1 -> t2) -> t2 infixl 8 Source #

getRequestBody :: (?requestContext :: RequestContext) => IO ByteString Source #

getRequestPath :: (?requestContext :: RequestContext) => ByteString Source #

Returns the request path, e.g. /Users or /CreateUser

getRequestPathAndQuery :: (?requestContext :: RequestContext) => ByteString Source #

Returns the request path and the query params, e.g. /ShowUser?userId=9bd6b37b-2e53-40a4-bb7b-fdba67d6af42

getHeader :: (?requestContext :: RequestContext) => ByteString -> Maybe ByteString Source #

Returns a header value for a given header name. Returns Nothing if not found

The header is looked up in a case insensitive way.

>>> getHeader "Content-Type"
Just "text/html"

>>> getHeader "X-My-Custom-Header"
Nothing

data RequestContext Source #

Constructors

RequestContext Request Respond [Param] [File ByteString] (Key (Session IO String String))

request :: (?requestContext :: RequestContext) => Request Source #

Returns the current HTTP request.

See https://hackage.haskell.org/package/wai-3.2.2.1/docs/Network-Wai.html#t:Request

requestHeaders :: Request -> RequestHeaders #

getFiles :: (?requestContext :: RequestContext) => [File ByteString] Source #

class (Show controller, Eq controller) => Controller controller where Source #

Minimal complete definition

action

Methods

beforeAction :: (?controllerContext :: ControllerContext, ?modelContext :: ModelContext, ?requestContext :: RequestContext, ?theAction :: controller) => IO () Source #

action :: (?controllerContext :: ControllerContext, ?modelContext :: ModelContext, ?requestContext :: RequestContext, ?theAction :: controller) => controller -> IO () Source #

Instances

Instances details

Controller CodeGenController Source #
Instance details Defined in IHP.IDE.CodeGen.Controller Methods beforeAction :: IO () Source # action :: CodeGenController -> IO () Source #
Controller LogsController Source #
Instance details Defined in IHP.IDE.Logs.Controller Methods beforeAction :: IO () Source # action :: LogsController -> IO () Source #
Controller DataController Source #
Instance details Defined in IHP.IDE.Data.Controller Methods beforeAction :: IO () Source # action :: DataController -> IO () Source #
Controller EnumValuesController Source #
Instance details Defined in IHP.IDE.SchemaDesigner.Controller.EnumValues Methods beforeAction :: IO () Source # action :: EnumValuesController -> IO () Source #
Controller EnumsController Source #
Instance details Defined in IHP.IDE.SchemaDesigner.Controller.Enums Methods beforeAction :: IO () Source # action :: EnumsController -> IO () Source #
Controller ColumnsController Source #
Instance details Defined in IHP.IDE.SchemaDesigner.Controller.Columns Methods beforeAction :: IO () Source # action :: ColumnsController -> IO () Source #
Controller TablesController Source #
Instance details Defined in IHP.IDE.SchemaDesigner.Controller.Tables Methods beforeAction :: IO () Source # action :: TablesController -> IO () Source #
Controller SchemaController Source #
Instance details Defined in IHP.IDE.SchemaDesigner.Controller.Schema Methods beforeAction :: IO () Source # action :: SchemaController -> IO () Source #
Controller WelcomeController Source #
Instance details Defined in IHP.Welcome.Controller Methods beforeAction :: IO () Source # action :: WelcomeController -> IO () Source #

runAction :: forall controller. (Controller controller, ?requestContext :: RequestContext, ?controllerContext :: ControllerContext, ?modelContext :: ModelContext, FrameworkConfig) => controller -> IO ResponseReceived Source #

createRequestContext :: ApplicationContext -> Request -> Respond -> IO RequestContext Source #

data ControllerContext Source #

fromControllerContext :: forall a. (?controllerContext :: ControllerContext, Typeable a) => a Source #

maybeFromControllerContext :: forall a. (?controllerContext :: ControllerContext, Typeable a) => Maybe a Source #

class InitControllerContext application where Source #

Minimal complete definition

Nothing

Methods

initContext :: (?modelContext :: ModelContext, ?requestContext :: RequestContext, ?applicationContext :: ApplicationContext) => TMap -> IO TMap Source #

Instances

Instances details

InitControllerContext ToolServerApplication Source #
Instance details Defined in IHP.IDE.ToolServer Methods initContext :: TMap -> IO TMap Source #

runActionWithNewContext :: forall application controller. (Controller controller, ?applicationContext :: ApplicationContext, ?requestContext :: RequestContext, InitControllerContext application, ?application :: application, Typeable application, Typeable controller, FrameworkConfig) => controller -> IO ResponseReceived Source #

emptyControllerContext :: ControllerContext Source #

respondAndExit :: Response -> IO () Source #

newtype ActionType Source #

Constructors

ActionType TypeRep

data ResponseException Source #

Constructors

ResponseException Response

Instances

Instances details

Show ResponseException Source #
Instance details Defined in IHP.ControllerSupport Methods showsPrec :: Int -> ResponseException -> ShowS # show :: ResponseException -> String showList :: [ResponseException] -> ShowS #
Exception ResponseException Source #
Instance details Defined in IHP.ControllerSupport Methods toException :: ResponseException -> SomeException # fromException :: SomeException -> Maybe ResponseException # displayException :: ResponseException -> String #