webbase

package

v1.3.2-0...-4312943 Latest Latest Go to latest Published: Jun 9, 2022 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Base struct {
	web.Base
}

Base defines the web handler module.

func NewBase(traced bool) Base

NewBase returns a new web handler module.

func (w *Base) Handler(
	tmpl string,
	dataGetter func(*gin.Context) (interface{}, *Error),
) gin.HandlerFunc

Handler returns a gin handler rendering tmpl with data from dataGetter and 200 status code.

func (w *Base) ServeErr(ctx *gin.Context, err *Error)

ServeErr serves a html err page.

func (w *Base) UnAuthHandler(tmpl string,
	dataGetter func(*gin.Context) (interface{}, *Error),
) gin.HandlerFunc

UnAuthHandler returns a gin handler rendering tmpl with data from dataGetter and 401 status code.

type Data struct {
	Title      string
	BinVersion string
	Ctx        struct {
		Org, User   string
		LoggedIn    bool
		AuthEnabled bool
	}
}

Data defines the base data.

func NewData(title string, ginctx *gin.Context) Data

NewData returns a database.

type Error struct {
	StatusCode int
	Messages   []string
	Log        string
}

Error defines the web error.

type ErrorPage struct {
	Data
	StatusCode  int
	ErrTitle    string
	Description string
}

ErrorPage defines the data for error.html template.

func NewErrorPage(ctx *gin.Context) ErrorPage

NewErrorPage returns error page data.