Safe HaskellNone

IHP.ControllerSupport

Synopsis

Documentation

type Action' = IO ResponseReceived Source #

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

getRequestPath :: (?context :: ControllerContext) => ByteString Source #

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

getRequestPathAndQuery :: (?context :: ControllerContext) => ByteString Source #

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

getHeader :: (?context :: ControllerContext) => 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

requestHeaders :: Request -> RequestHeaders #

getFiles :: (?context :: ControllerContext) => [File ByteString] Source #

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

Minimal complete definition

action

Methods

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

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

Instances

Instances details
Controller CodeGenController Source # 
Instance details

Defined in IHP.IDE.CodeGen.Controller

Controller LogsController Source # 
Instance details

Defined in IHP.IDE.Logs.Controller

Controller DataController Source # 
Instance details

Defined in IHP.IDE.Data.Controller

Controller EnumValuesController Source # 
Instance details

Defined in IHP.IDE.SchemaDesigner.Controller.EnumValues

Controller EnumsController Source # 
Instance details

Defined in IHP.IDE.SchemaDesigner.Controller.Enums

Controller ColumnsController Source # 
Instance details

Defined in IHP.IDE.SchemaDesigner.Controller.Columns

Controller TablesController Source # 
Instance details

Defined in IHP.IDE.SchemaDesigner.Controller.Tables

Controller SchemaController Source # 
Instance details

Defined in IHP.IDE.SchemaDesigner.Controller.Schema

Controller WelcomeController Source # 
Instance details

Defined in IHP.Welcome.Controller

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

data ControllerContext Source #

A container storing useful data along the request lifecycle, such as the request, the current user, set current view layout, flash messages, ...

The controller context is usually accessed via the ?context variable. It's availble inside the action and the view. Think of it as a key-value-map where the key is the type of the value.

You can store information inside the context using putContext:

>>> newtype CurrentLayout = CurrentLayout Html
>>> 
>>> ?context <- newControllerContext
>>> putContext (CurrentLayout layout)

Inside an action you can access the values using fromContext:

>>> (CurrentLayout layout) <- fromContext

You can freeze the context and then access values without being inside an IO context (like inside views which are pure):

Call freeze inside an IO part:

>>> ?context <- freeze ?context

(freeze is automatically called by IHP before rendering a view, so usually you don't need to call it manually)

Then use the frozen context from your pure code like this:

>>> let (CurrentLayout layout) = fromFrozenContext in ...

The context is initially created before a action is going to be executed. It's life cycle looks like this:

  • newControllerContext: The new controller context is created
  • The runActionWithNewContext fills in a few default values: The current ?application and also the Flash Messages to be rendered in the to-be-generated response.
  • initContext: The initContext function of the InitControllerContext WebApplication (inside your FrontController.hs) is called. There application-specific context can be provided. Usually this is the current user and the default layout.
  • beforeAction: Here the context could also be modified. E.g. the layout could be overriden here for the whole controller.
  • action ..: The action itself.
  • Freezing: Before rendering the response, the container is frozen. Frozen means that all previously mutable fields become immutable.
  • View Rendering: The frozen container is now used inside the view and layout to display information such as the current user or flash messages

class InitControllerContext application where Source #

Minimal complete definition

Nothing

Methods

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

Instances

Instances details
InitControllerContext () Source # 
Instance details

Defined in IHP.Server

Methods

initContext :: IO () Source #

InitControllerContext ToolServerApplication Source # 
Instance details

Defined in IHP.IDE.ToolServer

Methods

initContext :: IO () Source #

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

respondAndExit :: Response -> IO () Source #

jumpToAction :: forall action. (Controller action, ?context :: ControllerContext, ?modelContext :: ModelContext) => action -> IO () Source #

startWebSocketApp :: forall webSocketApp application. (?applicationContext :: ApplicationContext, ?context :: RequestContext, InitControllerContext application, ?application :: application, Typeable application, WSApp webSocketApp) => IO ResponseReceived Source #