Documentation

Overview

    Package response is responsible for loading and rendering authboss templates.

    Index

    Constants

    This section is empty.

    Variables

    View Source
    var (
    	// ErrTemplateNotFound should be returned from Get when the view is not found
    	ErrTemplateNotFound = errors.New("Template not found")
    )

    Functions

    func Asset

    func Asset(name string) ([]byte, error)

      Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

      func AssetDir

      func AssetDir(name string) ([]string, error)

        AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

        data/
          foo.txt
          img/
            a.png
            b.png
        

        then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

        func AssetInfo

        func AssetInfo(name string) (os.FileInfo, error)

          AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

          func AssetNames

          func AssetNames() []string

            AssetNames returns the names of the assets.

            func Email

            func Email(mailer authboss.Mailer, email authboss.Email, htmlTpls Templates, nameHTML string, textTpls Templates, namePlain string, data interface{}) error

              RenderEmail renders the html and plaintext views for an email and sends it

              func MustAsset

              func MustAsset(name string) []byte

                MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

                func Redirect

                func Redirect(ctx *authboss.Context, w http.ResponseWriter, r *http.Request, path, flashSuccess, flashError string, followRedir bool)

                  Redirect sets any flash messages given and redirects the user. If flashSuccess or flashError are set they will be set in the session. If followRedir is set to true, it will attempt to grab the redirect path from the query string.

                  func RestoreAsset

                  func RestoreAsset(dir, name string) error

                    RestoreAsset restores an asset under the given directory

                    func RestoreAssets

                    func RestoreAssets(dir, name string) error

                      RestoreAssets restores an asset under the given directory recursively

                      Types

                      type Templates

                      type Templates map[string]*template.Template

                        Templates is a map depicting the forms a template needs wrapped within the specified layout

                        func LoadTemplates

                        func LoadTemplates(ab *authboss.Authboss, layout *template.Template, fpath string, files ...string) (Templates, error)

                          LoadTemplates parses all specified files located in fpath. Each template is wrapped in a unique clone of layout. All templates are expecting {{authboss}} handlebars for parsing. It will check the override directory specified in the config, replacing any templates as necessary.

                          func (Templates) Render

                            Render renders a view with xsrf and flash attributes.