admin

Documentation

Index

• Variables
• func Register[T ModelInterface[T]](m AdminOptions[T])
• func RegisterExtension(ext extensions.Extension)
• func Route() router.Registrar
• func Unauthorized(r *request.Request, msg ...string)
• type AdminDisplayer
• type AdminOptions
• type Application
• type Model
• type ModelInterface
• type Permissions

Variables

var (
	AdminSite_Name                  = "Admin"
	AdminSite_URL                   = "/admin"
	AdminSite_Logger request.Logger = &request.NopLogger{}

	AdminSite_ExtensionTemplateManager *templates.Manager
	AdminSite_ExtensionOptions         *extensions.Options
)

var (
	PermissionViewAdminSite = "view_admin_site"
)

Functions

func Register

func Register[T ModelInterface[T]](m AdminOptions[T])

func RegisterExtension

func RegisterExtension(ext extensions.Extension)

Register an extension to the admin site.

Extensions are separate templates that can be used to add extra functionality

These templates are embedded into the admin site's base template.

func Route

func Route() router.Registrar

func Unauthorized

func Unauthorized(r *request.Request, msg ...string)

Unauthorized redirects the user to the unauthorized page. It will also log a stacktrace of the code that called this function.

Types

type AdminDisplayer

type AdminDisplayer interface {
	AdminDisplay() string
}

type AdminOptions

type AdminOptions[T ModelInterface[T]] struct {
	FormFields []string
	ListFields []string
	Model      T
}

type Application

type Application struct {
	Name   string
	Models *orderedmap.Map[string, *Model]
	Index  router.Registrar
	URL    string
}

type Model

type Model struct {
	Name string
	Pkg  string

	URL_List   routevars.URLFormatter
	URL_Create routevars.URLFormatter
	URL_Update routevars.URLFormatter
	URL_Delete routevars.URLFormatter

	Model any

	Permissions Permissions
}

type ModelInterface

type ModelInterface[T any] interface {
	interfaces.Saver
	interfaces.Deleter
	interfaces.StringGetter[T]
	interfaces.Lister[T]
}

type Permissions

type Permissions struct {
	Create string // Name of the Create permission
	Update string // Name of the Update permission
	Delete string // Name of the Delete permission
	List   string // Name of the List permission
}