phx

README

🐦 Phx

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

Documentation

Index

• func GetUser(req *http.Request) session.User
• func ParseForm(req *http.Request, dst interface{})
• func PrintLogo(logoFile string)
• func Redirect(to string) func() http.HandlerFunc
• type Builder
• type HtmlRenderer
  • func NewHtmlRenderer(files embed.FS, csrf csrf.Csrf, localizer localizer.LocalizerStore) HtmlRenderer
  • func NewHtmlRendererWithExtraFuncs(files embed.FS, csrf csrf.Csrf, localizer localizer.LocalizerStore, ...) HtmlRenderer
  • func (r HtmlRenderer) CreateView(req *http.Request, tmpl *template.Template, model interface{}) View
  • func (r HtmlRenderer) Parse(patterns ...string) *template.Template
  • func (r HtmlRenderer) ParseAlone(file string) *template.Template
  • func (r HtmlRenderer) ParsePartial(defName string, patterns ...string) *template.Template
  • func (r HtmlRenderer) ParseWithShared(patterns ...string) *template.Template
• type Injector
  • func NewInjector() *Injector
  • func (injector Injector) Add(builder Builder)
  • func (injector Injector) CallBuilder(builder Builder) interface{}
  • func (injector Injector) Get(name interface{}) interface{}
  • func (injector Injector) GetByType(name reflect.Type) interface{}
  • func (injector Injector) PopulateStruct(userStruct interface{})
  • func (injector Injector) ResolveHandler(builder Builder) http.HandlerFunc
  • func (injector Injector) ShowAvailableBuilders()
• type Middleware
• type Mux
  • func NewMux() Mux
  • func NewMuxEmpty() Mux
  • func NewMuxFrom(other Mux) Mux
  • func (mux *Mux) Add(builder Builder)
  • func (mux *Mux) Any(pattern string, builder Builder, middlewares ...Middleware)
  • func (mux *Mux) Delete(pattern string, builder Builder, middlewares ...Middleware)
  • func (mux *Mux) FileServer(pattern, root string)
  • func (mux *Mux) FileServerStatic(path string)
  • func (mux *Mux) Get(pattern string, builder Builder, middlewares ...Middleware)
  • func (mux *Mux) Head(pattern string, builder Builder, middlewares ...Middleware)
  • func (mux Mux) ListenAndServe(address string)
  • func (mux *Mux) Mount(pattern string, inner *Mux)
  • func (mux *Mux) Options(pattern string, builder Builder, middlewares ...Middleware)
  • func (mux *Mux) Patch(pattern string, builder Builder, middlewares ...Middleware)
  • func (mux *Mux) PopulateStruct(s interface{})
  • func (mux *Mux) Post(pattern string, builder Builder, middlewares ...Middleware)
  • func (mux *Mux) Put(pattern string, builder Builder, middlewares ...Middleware)
  • func (mux *Mux) ShowAvailableBuilders()
  • func (mux *Mux) Trace(pattern string, builder Builder, middlewares ...Middleware)
  • func (mux *Mux) Use(middleware Middleware)
• type Render
  • func NewJsonRenderer(w http.ResponseWriter, req *http.Request) Render
• type View
  • func (view View) Execute(w io.Writer) error
  • func (view *View) FillFormErrors(e map[string]string)
  • func (view View) RenderLocalized(w io.Writer, req *http.Request, localizerKey string) error
• type ViewModel
  • func (vm ViewModel) GetFormError(key string) string
  • func (vm ViewModel) HaveFormError(key string) bool
  • func (vm ViewModel) Localize(key string) string

Functions

func GetUser

func GetUser(req *http.Request) session.User

func ParseForm

func ParseForm(req *http.Request, 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 PrintLogo

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() http.HandlerFunc

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 HtmlRenderer

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

func NewHtmlRenderer

func NewHtmlRenderer(files embed.FS, csrf csrf.Csrf, localizer localizer.LocalizerStore) HtmlRenderer

func NewHtmlRendererWithExtraFuncs

func NewHtmlRendererWithExtraFuncs(files embed.FS, csrf csrf.Csrf, localizer localizer.LocalizerStore, extra template.FuncMap) HtmlRenderer

func (HtmlRenderer) CreateView

func (r HtmlRenderer) CreateView(req *http.Request, tmpl *template.Template, model interface{}) View

func (HtmlRenderer) Parse

func (r HtmlRenderer) Parse(patterns ...string) *template.Template

func (HtmlRenderer) ParseAlone

func (r HtmlRenderer) ParseAlone(file string) *template.Template

func (HtmlRenderer) ParsePartial

func (r HtmlRenderer) ParsePartial(defName string, patterns ...string) *template.Template

func (HtmlRenderer) ParseWithShared

func (r HtmlRenderer) ParseWithShared(patterns ...string) *template.Template

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) http.HandlerFunc

ResolveHandler created by a builder

func (Injector) ShowAvailableBuilders

func (injector Injector) ShowAvailableBuilders()

ShowAvailableBuilders prints all registered builders.

type Middleware

type Middleware func(http.HandlerFunc) http.HandlerFunc

type Mux

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

func NewMux

func NewMux() Mux

func NewMuxEmpty

func NewMuxEmpty() Mux

func NewMuxFrom

func NewMuxFrom(other Mux) Mux

func (*Mux) Add

func (mux *Mux) Add(builder Builder)

func (*Mux) Any

func (mux *Mux) Any(pattern string, builder Builder, middlewares ...Middleware)

func (*Mux) Delete

func (mux *Mux) Delete(pattern string, builder Builder, middlewares ...Middleware)

func (*Mux) FileServer

func (mux *Mux) FileServer(pattern, root string)

FileServer creates using a router, a url path and a file path a file server.

func (*Mux) FileServerStatic

func (mux *Mux) FileServerStatic(path string)

FileServerStatic creates a file server with your desired path a file server that serves files in ./static folder.

func (*Mux) Get

func (mux *Mux) Get(pattern string, builder Builder, middlewares ...Middleware)

func (*Mux) Head

func (mux *Mux) Head(pattern string, builder Builder, middlewares ...Middleware)

func (Mux) ListenAndServe

func (mux Mux) ListenAndServe(address string)

func (*Mux) Mount

func (mux *Mux) Mount(pattern string, inner *Mux)

func (*Mux) Options

func (mux *Mux) Options(pattern string, builder Builder, middlewares ...Middleware)

func (*Mux) Patch

func (mux *Mux) Patch(pattern string, builder Builder, middlewares ...Middleware)

func (*Mux) PopulateStruct

func (mux *Mux) PopulateStruct(s interface{})

func (*Mux) Post

func (mux *Mux) Post(pattern string, builder Builder, middlewares ...Middleware)

func (*Mux) Put

func (mux *Mux) Put(pattern string, builder Builder, middlewares ...Middleware)

func (*Mux) ShowAvailableBuilders

func (mux *Mux) ShowAvailableBuilders()

func (*Mux) Trace

func (mux *Mux) Trace(pattern string, builder Builder, middlewares ...Middleware)

func (*Mux) Use

func (mux *Mux) Use(middleware Middleware)

type Render

type Render func(data interface{}, err error)

func NewJsonRenderer

func NewJsonRenderer(w http.ResponseWriter, req *http.Request) Render

type View

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

func (View) Execute

func (view View) Execute(w io.Writer) error

func (*View) FillFormErrors

func (view *View) FillFormErrors(e map[string]string)

func (View) RenderLocalized

func (view View) RenderLocalized(w io.Writer, req *http.Request, localizerKey string) error

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