Documentation
¶
Index ¶
- type PluginFn
- type PluginLogger
- func (l *PluginLogger) Debug(format string, v ...interface{})
- func (l *PluginLogger) Error(format string, v ...interface{})
- func (l *PluginLogger) Info(format string, v ...interface{})
- func (l *PluginLogger) Log(level ambient.LogLevel, format string, v ...interface{})
- func (l *PluginLogger) Warn(format string, v ...interface{})
- type PluginRouteRecorder
- func (rec *PluginRouteRecorder) Delete(path string, fn func(http.ResponseWriter, *http.Request) (err error))
- func (rec *PluginRouteRecorder) Error(status int, w http.ResponseWriter, r *http.Request)
- func (rec *PluginRouteRecorder) Get(path string, fn func(http.ResponseWriter, *http.Request) (err error))
- func (rec *PluginRouteRecorder) Handle(method string, path string, ...)
- func (rec *PluginRouteRecorder) Head(path string, fn func(http.ResponseWriter, *http.Request) (err error))
- func (rec *PluginRouteRecorder) Options(path string, fn func(http.ResponseWriter, *http.Request) (err error))
- func (rec *PluginRouteRecorder) Param(r *http.Request, name string) string
- func (rec *PluginRouteRecorder) Patch(path string, fn func(http.ResponseWriter, *http.Request) (err error))
- func (rec *PluginRouteRecorder) Post(path string, fn func(http.ResponseWriter, *http.Request) (err error))
- func (rec *PluginRouteRecorder) Put(path string, fn func(http.ResponseWriter, *http.Request) (err error))
- func (rec *PluginRouteRecorder) Routes() []ambient.Route
- func (rec *PluginRouteRecorder) StatusError(status int, err error) error
- func (rec *PluginRouteRecorder) Wrap(handler http.HandlerFunc) func(w http.ResponseWriter, r *http.Request) (err error)
- type RouteRecorder
- type TemplateRenderer
- func (rr *TemplateRenderer) Error(w http.ResponseWriter, r *http.Request, content string, statusCode int, ...) (err error)
- func (rr *TemplateRenderer) Page(w http.ResponseWriter, r *http.Request, assets ambient.FileSystemReader, ...) (err error)
- func (rr *TemplateRenderer) PageContent(w http.ResponseWriter, r *http.Request, content string, ...) (err error)
- func (rr *TemplateRenderer) Post(w http.ResponseWriter, r *http.Request, assets ambient.FileSystemReader, ...) (err error)
- func (rr *TemplateRenderer) PostContent(w http.ResponseWriter, r *http.Request, content string, ...) (err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type PluginLogger ¶
type PluginLogger struct {
// contains filtered or unexported fields
}
PluginLogger represents a plugin logger.
func NewPluginLogger ¶
func NewPluginLogger(logger ambient.AppLogger) *PluginLogger
NewPluginLogger returns a new logger with a default log level of error.
func (*PluginLogger) Debug ¶
func (l *PluginLogger) Debug(format string, v ...interface{})
Debug is equivalent to log.Printf() + "\n" if format is not empty. It's equivalent to Println() if format is empty.
func (*PluginLogger) Error ¶
func (l *PluginLogger) Error(format string, v ...interface{})
Error is equivalent to log.Printf() + "\n" if format is not empty. It's equivalent to Println() if format is empty.
func (*PluginLogger) Info ¶
func (l *PluginLogger) Info(format string, v ...interface{})
Info is equivalent to log.Printf() + "\n" if format is not empty. It's equivalent to Println() if format is empty.
func (*PluginLogger) Log ¶
func (l *PluginLogger) Log(level ambient.LogLevel, format string, v ...interface{})
Log is equivalent to log.Printf() + "\n" if format is not empty. It's equivalent to Println() if format is empty.
func (*PluginLogger) Warn ¶
func (l *PluginLogger) Warn(format string, v ...interface{})
Warn is equivalent to log.Printf() + "\n" if format is not empty. It's equivalent to Println() if format is empty.
type PluginRouteRecorder ¶
type PluginRouteRecorder struct {
// contains filtered or unexported fields
}
PluginRouteRecorder is a route recorder for a plugin.
func (*PluginRouteRecorder) Delete ¶
func (rec *PluginRouteRecorder) Delete(path string, fn func(http.ResponseWriter, *http.Request) (err error))
Delete request handler.
func (*PluginRouteRecorder) Error ¶
func (rec *PluginRouteRecorder) Error(status int, w http.ResponseWriter, r *http.Request)
Error handler.
func (*PluginRouteRecorder) Get ¶
func (rec *PluginRouteRecorder) Get(path string, fn func(http.ResponseWriter, *http.Request) (err error))
Get request handler.
func (*PluginRouteRecorder) Handle ¶
func (rec *PluginRouteRecorder) Handle(method string, path string, fn func(http.ResponseWriter, *http.Request) (err error))
Handle request handler.
func (*PluginRouteRecorder) Head ¶
func (rec *PluginRouteRecorder) Head(path string, fn func(http.ResponseWriter, *http.Request) (err error))
Head request handler.
func (*PluginRouteRecorder) Options ¶
func (rec *PluginRouteRecorder) Options(path string, fn func(http.ResponseWriter, *http.Request) (err error))
Options request handler.
func (*PluginRouteRecorder) Param ¶
func (rec *PluginRouteRecorder) Param(r *http.Request, name string) string
Param request handler.
func (*PluginRouteRecorder) Patch ¶
func (rec *PluginRouteRecorder) Patch(path string, fn func(http.ResponseWriter, *http.Request) (err error))
Patch request handler.
func (*PluginRouteRecorder) Post ¶
func (rec *PluginRouteRecorder) Post(path string, fn func(http.ResponseWriter, *http.Request) (err error))
Post request handler.
func (*PluginRouteRecorder) Put ¶
func (rec *PluginRouteRecorder) Put(path string, fn func(http.ResponseWriter, *http.Request) (err error))
Put request handler.
func (*PluginRouteRecorder) Routes ¶
func (rec *PluginRouteRecorder) Routes() []ambient.Route
Routes returns list of routes.
func (*PluginRouteRecorder) StatusError ¶
func (rec *PluginRouteRecorder) StatusError(status int, err error) error
StatusError handler.
func (*PluginRouteRecorder) Wrap ¶
func (rec *PluginRouteRecorder) Wrap(handler http.HandlerFunc) func(w http.ResponseWriter, r *http.Request) (err error)
Wrap for http.HandlerFunc.
type RouteRecorder ¶
type RouteRecorder struct {
// contains filtered or unexported fields
}
RouteRecorder handles routing for plugins.
func NewRouteRecorder ¶
func NewRouteRecorder(log ambient.AppLogger, pluginsystem ambient.PluginSystem, mux ambient.AppRouter) *RouteRecorder
NewRouteRecorder returns a route recorder for use in plugins.
func (*RouteRecorder) WithPlugin ¶
func (rec *RouteRecorder) WithPlugin(pluginName string) *PluginRouteRecorder
WithPlugin sets up recorder for a plugin.
type TemplateRenderer ¶
type TemplateRenderer struct {
// contains filtered or unexported fields
}
TemplateRenderer represents a plugin template enginer.
func NewRenderer ¶
func NewRenderer(render ambient.Renderer) *TemplateRenderer
NewRenderer returns a new template engine for plugins.
func (*TemplateRenderer) Error ¶
func (rr *TemplateRenderer) Error(w http.ResponseWriter, r *http.Request, content string, statusCode int, fm func(r *http.Request) template.FuncMap, vars map[string]interface{}) (err error)
Error renders an error.
func (*TemplateRenderer) Page ¶
func (rr *TemplateRenderer) Page(w http.ResponseWriter, r *http.Request, assets ambient.FileSystemReader, templateName string, fm func(r *http.Request) template.FuncMap, vars map[string]interface{}) (err error)
Page renders a page.
func (*TemplateRenderer) PageContent ¶
func (rr *TemplateRenderer) PageContent(w http.ResponseWriter, r *http.Request, content string, fm func(r *http.Request) template.FuncMap, vars map[string]interface{}) (err error)
PageContent renders page content.
func (*TemplateRenderer) Post ¶
func (rr *TemplateRenderer) Post(w http.ResponseWriter, r *http.Request, assets ambient.FileSystemReader, templateName string, fm func(r *http.Request) template.FuncMap, vars map[string]interface{}) (err error)
Post renders a post.
func (*TemplateRenderer) PostContent ¶
func (rr *TemplateRenderer) PostContent(w http.ResponseWriter, r *http.Request, content string, fm func(r *http.Request) template.FuncMap, vars map[string]interface{}) (err error)
PostContent renders post content.
Source Files
Click to show internal directories.
Click to hide internal directories.