phx

package module
v0.0.20 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 19, 2023 License: MIT Imports: 21 Imported by: 0

README

🐦 Phx

A little, highly opinated framework to create complete web apps.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions 

func PrintLogo(logoFile string)

PrintLogo takes a file path and prints your fancy ascii logo. It will fail if your file is not found.

func Redirect 

func Redirect(to string) func() Handler

Types

type Builder 

type Builder interface{}

Builder is a function that expects anything and retuns the type that builds. The type cant be func() interface{} cause some errors appears in runtime. So it's represented as an interface.

type Context added in v0.0.15 

type Context struct {
	Req *http.Request
	Res http.ResponseWriter
	// contains filtered or unexported fields
}

func (*Context) ChangeLangauge added in v0.0.18 

func (ctx *Context) ChangeLangauge(to string)

func (*Context) GetCurrentLanguage added in v0.0.18 

func (ctx *Context) GetCurrentLanguage() string

func (*Context) GetParam added in v0.0.17 

func (ctx *Context) GetParam(name string) string

func (*Context) GetUser added in v0.0.15 

func (ctx *Context) GetUser() session.User

func (*Context) Json added in v0.0.15 

func (ctx *Context) Json(status int, data interface{})

func (*Context) ParseForm added in v0.0.18 

func (ctx *Context) ParseForm(dst interface{})

ParseForm parses req.Form and then serializes the form data to the dst struct using reflection. The form names should match to the 'html' tag or, if its not setted, to the field name. ParseForm only supports serializing data to one-depth structs. Example, using this struct as target: 

type MyStruct struct {
		A bool,
		B int `html:"pagination.currentPage"`
}

And having this serialized form:

"A=false&pagination.currentPage=2"

Calling ParseForm like this (NOTE THAT A POINTER TO THE STRUCT IS BEING PASSED):

var s MyStruct phx.ParseForm(req, &s)

It will result to this fullfilled struct:

{ A = false, B: 2 }

The supported field types are: int, int8, int16, int32, int64, float32, float64, bool and string

func (*Context) Redirect added in v0.0.15 

func (ctx *Context) Redirect(to string)

func (*Context) RedirectCode added in v0.0.18 

func (ctx *Context) RedirectCode(to string, code int)

func (*Context) Render added in v0.0.15 

func (ctx *Context) Render(status int, parsed string, vm interface{})

func (*Context) RenderWithErrors added in v0.0.15 

func (ctx *Context) RenderWithErrors(status int, parsed string, vm interface{}, formErrors map[string]string)

func (*Context) String added in v0.0.18 

func (ctx *Context) String(data string, a ...any)

type CorsConfig added in v0.0.15 

type CorsConfig struct {
	AllowMethods string
	AllowOrigin  string
}

type Handler added in v0.0.15 

type Handler func(c *Context)

type Injector 

type Injector struct {
	// contains filtered or unexported fields
}

Injector is an automated dependency injector inspired in Sping's DI. It will detect which builder to call using its return type. If the builder haver params, it will fullfill that params calling other builders that provides its types.

func NewInjector 

func NewInjector() *Injector

NewInjector with default values

func (Injector) Add 

func (injector Injector) Add(builder Builder)

Add a builder to the dependency injector.

func (Injector) CallBuilder 

func (injector Injector) CallBuilder(builder Builder) interface{}

CallBuilder injecting all parameters with provided builders. If some parameter type cannot be found, it will panic

func (Injector) Get 

func (injector Injector) Get(name interface{}) interface{}

Get returns a builded dependency

func (Injector) GetByType 

func (injector Injector) GetByType(name reflect.Type) interface{}

GetByType returns a builded dependency identified by type

func (Injector) PopulateStruct 

func (injector Injector) PopulateStruct(userStruct interface{})

PopulateStruct fills a struct with the implementations that the injector can create. Make sure you pass a reference and not a value

func (Injector) ResolveHandler 

func (injector Injector) ResolveHandler(builder Builder) Handler

ResolveHandler created by a builder

func (Injector) ShowAvailableBuilders 

func (injector Injector) ShowAvailableBuilders()

ShowAvailableBuilders prints all registered builders.

type Middleware 

type Middleware func(Handler) Handler

type Router added in v0.0.15 

type Router struct {
	// contains filtered or unexported fields
}

func NewRouter added in v0.0.15 

func NewRouter() *Router

func NewRouterFromOther added in v0.0.15 

func NewRouterFromOther(r *Router) *Router

func NewRouterWithConfig added in v0.0.15 

func NewRouterWithConfig() *Router

func (*Router) Add added in v0.0.15 

func (r *Router) Add(builder Builder)

func (*Router) AddDefaultTemplateFunctions added in v0.0.15 

func (r *Router) AddDefaultTemplateFunctions()

func (*Router) Bootstrap added in v0.0.15 

func (r *Router) Bootstrap()

func (*Router) Delete added in v0.0.15 

func (r *Router) Delete(pattern string, builder Builder, middlewares ...Middleware)

func (*Router) Get added in v0.0.15 

func (r *Router) Get(pattern string, builder Builder, middlewares ...Middleware)

func (*Router) Handle added in v0.0.15 

func (r *Router) Handle(method, pattern string, builder Builder, middlewares ...Middleware)

func (*Router) Head added in v0.0.15 

func (r *Router) Head(pattern string, builder Builder, middlewares ...Middleware)

func (*Router) Options added in v0.0.15 

func (r *Router) Options(pattern string, builder Builder, middlewares ...Middleware)

func (*Router) Parse added in v0.0.15 

func (r *Router) Parse(name string, patterns ...string)

func (*Router) ParsePartial added in v0.0.15 

func (r *Router) ParsePartial(name string, patterns ...string)

func (*Router) Patch added in v0.0.15 

func (r *Router) Patch(pattern string, builder Builder, middlewares ...Middleware)

func (*Router) PopulateStruct added in v0.0.15 

func (r *Router) PopulateStruct(s interface{})

func (*Router) Post added in v0.0.15 

func (r *Router) Post(pattern string, builder Builder, middlewares ...Middleware)

func (*Router) Put added in v0.0.15 

func (r *Router) Put(pattern string, builder Builder, middlewares ...Middleware)

func (Router) Run added in v0.0.15 

func (r Router) Run(address string)

func (*Router) ShowAvailableBuilders added in v0.0.15 

func (r *Router) ShowAvailableBuilders()

func (*Router) Trace added in v0.0.15 

func (r *Router) Trace(pattern string, builder Builder, middlewares ...Middleware)

func (*Router) Use added in v0.0.15 

func (r *Router) Use(middleware Middleware)

func (*Router) UseCors added in v0.0.19 

func (r *Router) UseCors(methods, origin string)

func (*Router) UseCsrf added in v0.0.19 

func (r *Router) UseCsrf(expires time.Duration)

func (*Router) UseLocalization added in v0.0.19 

func (r *Router) UseLocalization(files embed.FS, sharedKey, errorsKey string)

func (*Router) UseStatic added in v0.0.19 

func (r *Router) UseStatic(path string)

func (*Router) UseTemplate added in v0.0.19 

func (r *Router) UseTemplate(fs embed.FS)

type SessionAuth added in v0.0.15 

type SessionAuth struct {
	// contains filtered or unexported fields
}

func NewSessionAuth added in v0.0.15 

func NewSessionAuth(sessionManager *session.Manager) SessionAuth

func NewSessionAuthWithRedirection added in v0.0.15 

func NewSessionAuthWithRedirection(sessionManager *session.Manager, redirectURL string) SessionAuth

func (SessionAuth) Admin added in v0.0.15 

func (authMiddle SessionAuth) Admin(next Handler) Handler

func (SessionAuth) Authorize added in v0.0.15 

func (authMiddle SessionAuth) Authorize(next Handler) Handler

func (SessionAuth) AuthorizeRoles added in v0.0.15 

func (authMiddle SessionAuth) AuthorizeRoles(roles []core.Role, next Handler) Handler

type ViewModel 

type ViewModel struct {
	Model      interface{}
	Localizer  localizer.Localizer
	FormErrors map[string]string
	CsrfToken  string
}

func (ViewModel) GetFormError 

func (vm ViewModel) GetFormError(key string) string

func (ViewModel) HaveFormError 

func (vm ViewModel) HaveFormError(key string) bool

func (ViewModel) Localize 

func (vm ViewModel) Localize(key string) string

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.