Yesod.Core
Description
The basic typeclass for a Yesod application.
- class RenderRoute (Route a) => Yesod a where
- approot :: a -> String
- encryptKey :: a -> IO (Maybe Key)
- clientSessionDuration :: a -> Int
- errorHandler :: ErrorResponse -> GHandler sub a ChooseRep
- defaultLayout :: GWidget sub a () -> GHandler sub a RepHtml
- urlRenderOverride :: a -> Route a -> Maybe String
- isAuthorized :: Route a -> Bool -> GHandler s a AuthResult
- isWriteRequest :: Route a -> GHandler s a Bool
- authRoute :: a -> Maybe (Route a)
- cleanPath :: a -> [String] -> Either [String] [String]
- joinPath :: a -> String -> [String] -> [(String, String)] -> String
- addStaticContent :: String -> String -> ByteString -> GHandler sub a (Maybe (Either String (Route a, [(String, String)])))
- sessionIpAddress :: a -> Bool
- class YesodDispatch a master where
- yesodDispatch :: Yesod master => a -> Maybe Key -> [String] -> master -> (Route a -> Route master) -> Maybe Application
- yesodRunner :: Yesod master => a -> master -> (Route a -> Route master) -> Maybe Key -> Maybe (Route a) -> GHandler a master ChooseRep -> Application
- class Eq u => RenderRoute u where
- renderRoute :: u -> ([String], [(String, String)])
- class YesodBreadcrumbs y where
- breadcrumbs :: YesodBreadcrumbs y => GHandler sub y (String, [(Route y, String)])
- maybeAuthorized :: Yesod a => Route a -> Bool -> GHandler s a (Maybe (Route a))
- widgetToPageContent :: (Eq (Route master), Yesod master) => GWidget sub master () -> GHandler sub master (PageContent (Route master))
- defaultErrorHandler :: Yesod y => ErrorResponse -> GHandler sub y ChooseRep
- data AuthResult
- yesodVersion :: String
- yesodRender :: Yesod y => y -> Route y -> [(String, String)] -> String
Type classes
class RenderRoute (Route a) => Yesod a whereSource
Define settings for a Yesod applications. The only required setting is
approot; other than that, there are intelligent defaults.
Methods
An absolute URL to the root of the application. Do not include trailing slash.
If you want to be lazy, you can supply an empty string under the following conditions:
- Your application is served from the root of the domain.
- You do not use any features that require absolute URLs, such as Atom feeds and XML sitemaps.
encryptKey :: a -> IO (Maybe Key)Source
The encryption key to be used for encrypting client sessions.
Returning Nothing disables sessions.
clientSessionDuration :: a -> IntSource
Number of minutes before a client session times out. Defaults to 120 (2 hours).
errorHandler :: ErrorResponse -> GHandler sub a ChooseRepSource
Output error response pages.
defaultLayout :: GWidget sub a () -> GHandler sub a RepHtmlSource
Applies some form of layout to the contents of a page.
urlRenderOverride :: a -> Route a -> Maybe StringSource
Override the rendering function for a particular URL. One use case for this is to offload static hosting to a different domain name to avoid sending cookies.
Arguments
| :: Route a | |
| -> Bool | is this a write request? |
| -> GHandler s a AuthResult |
Determine if a request is authorized or not.
Return Nothing is the request is authorized, Just a message if
unauthorized. If authentication is required, you should use a redirect;
the Auth helper provides this functionality automatically.
isWriteRequest :: Route a -> GHandler s a BoolSource
Determines whether the current request is a write request. By default, this assumes you are following RESTful principles, and determines this from request method. In particular, all except the following request methods are considered write: GET HEAD OPTIONS TRACE.
This function is used to determine if a request is authorized; see
isAuthorized.
authRoute :: a -> Maybe (Route a)Source
The default route for authentication.
Used in particular by isAuthorized, but library users can do whatever
they want with it.
cleanPath :: a -> [String] -> Either [String] [String]Source
A function used to clean up path segments. It returns Right with a
clean path or Left with a new set of pieces the user should be
redirected to. The default implementation enforces:
- No double slashes
- There is no trailing slash.
Note that versions of Yesod prior to 0.7 used a different set of rules involing trailing slashes.
Arguments
| :: a | |
| -> String | application root |
| -> [String] | path pieces |
| -> [(String, String)] | query string |
| -> String |
Join the pieces of a path together into an absolute URL. This should
be the inverse of splitPath.
Arguments
| :: String | filename extension |
| -> String | mime-type |
| -> ByteString | content |
| -> GHandler sub a (Maybe (Either String (Route a, [(String, String)]))) |
This function is used to store some static content to be served as an external file. The most common case of this is stashing CSS and JavaScript content in an external file; the Yesod.Widget module uses this feature.
The return value is Nothing if no storing was performed; this is the
default implementation. A Just Left gives the absolute URL of the
file, whereas a Just Right gives the type-safe URL. The former is
necessary when you are serving the content outside the context of a
Yesod application, such as via memcached.
sessionIpAddress :: a -> BoolSource
Whether or not to tie a session to a specific IP address. Defaults to
True.
class YesodDispatch a master whereSource
This class is automatically instantiated when you use the template haskell mkYesod function. You should never need to deal with it directly.
class Eq u => RenderRoute u whereSource
Methods
renderRoute :: u -> ([String], [(String, String)])Source
Breadcrumbs
class YesodBreadcrumbs y whereSource
A type-safe, concise method of creating breadcrumbs for pages. For each resource, you declare the title of the page and the parent resource (if present).
breadcrumbs :: YesodBreadcrumbs y => GHandler sub y (String, [(Route y, String)])Source
Gets the title of the current page and the hierarchy of parent pages, along with their respective titles.
Utitlities
Return the same URL if the user is authorized to see it.
Built on top of isAuthorized. This is useful for building page that only
contain links to pages the user is allowed to see.
widgetToPageContent :: (Eq (Route master), Yesod master) => GWidget sub master () -> GHandler sub master (PageContent (Route master))Source
Convert a widget to a PageContent.
Defaults
defaultErrorHandler :: Yesod y => ErrorResponse -> GHandler sub y ChooseRepSource
The default error handler for errorHandler.