Context Helpers¶

The framework and contrib apps store values in the request context. These helpers read and write those values.

Core Helpers¶

Defined in github.com/oliverandrich/burrow.

NavItems¶

func NavItems(ctx context.Context) []NavItem

Returns navigation items injected by the framework middleware. Returns nil if no items are set.

WithNavItems¶

func WithNavItems(ctx context.Context, items []NavItem) context.Context

Stores navigation items in the context. Used internally by the framework.

Layout¶

func Layout(ctx context.Context) LayoutFunc

Returns the app layout function from the context. Returns nil if no layout is set.

WithLayout¶

func WithLayout(ctx context.Context, fn LayoutFunc) context.Context

Stores the app layout function in the context. Used internally by the framework middleware.

Generic Helpers¶

func WithContextValue(ctx context.Context, key, val any) context.Context
func ContextValue[T any](ctx context.Context, key any) (T, bool)

Generic context value helpers. ContextValue is a typed getter that returns the value and a boolean indicating whether it was found.

Admin Helpers¶

Defined in github.com/oliverandrich/burrow/contrib/admin.

NavGroupsFromContext¶

func NavGroupsFromContext(ctx context.Context) []NavGroup

Returns the admin nav groups from the context. Each NavGroup contains an app name and its navigation items. Returns nil if not set.

WithNavGroups¶

func WithNavGroups(ctx context.Context, groups []NavGroup) context.Context

Stores admin nav groups in the context. Used internally by the admin route middleware.

RequestPathFromContext¶

func RequestPathFromContext(ctx context.Context) string

Returns the current request path from the context. Used by admin templates to highlight the active sidebar link. Returns "" if not set.

WithRequestPath¶

func WithRequestPath(ctx context.Context, path string) context.Context

Stores the current request path in the context. Used internally by the admin route middleware.

CSRF Helpers¶

Defined in github.com/oliverandrich/burrow/contrib/csrf.

Token¶

func Token(ctx context.Context) string

Returns the CSRF token from the context. Returns "" if not set.

WithToken¶

func WithToken(ctx context.Context, token string) context.Context

Stores a CSRF token in the context. Used internally by the CSRF middleware.

Auth Helpers¶

Defined in github.com/oliverandrich/burrow/contrib/auth.

UserFromContext¶

func UserFromContext(ctx context.Context) *User

Returns the authenticated user from the context, or nil if not logged in.

IsAuthenticated¶

func IsAuthenticated(ctx context.Context) bool

Returns true if a user is logged in.

WithUser¶

func WithUser(ctx context.Context, user *User) context.Context

Stores the user in the context. Used internally by the auth middleware.

Session Helpers¶

Defined in github.com/oliverandrich/burrow/contrib/session.

Getters¶

func GetString(r *http.Request, key string) string
func GetInt64(r *http.Request, key string) int64
func GetValues(r *http.Request) map[string]any

Read values from the session. Return zero values if the key is missing.

Setters¶

func Set(w http.ResponseWriter, r *http.Request, key string, value any) error
func Delete(w http.ResponseWriter, r *http.Request, key string) error
func Save(w http.ResponseWriter, r *http.Request, values map[string]any) error
func Clear(w http.ResponseWriter, r *http.Request)

Write values to the session. Set, Delete, and Save immediately write the cookie and return an error if the session middleware is not active.

Testing¶

func Inject(r *http.Request, values map[string]any) *http.Request

Sets up session state in the request context without the full middleware. Intended for use in tests. Returns a new *http.Request with the injected values.

i18n Helpers¶

Defined in github.com/oliverandrich/burrow/contrib/i18n.

Translation¶

func T(ctx context.Context, key string) string
func TData(ctx context.Context, key string, data map[string]any) string
func TPlural(ctx context.Context, key string, count int) string

Translate messages using the localizer from context. Fall back to the message ID if no translation is found.

Locale¶

func Locale(ctx context.Context) string

Returns the current locale (e.g., "en", "de"). Defaults to "en".

TranslateValidationErrors¶

func TranslateValidationErrors(ctx context.Context, ve *burrow.ValidationError)

Translates validation error messages in-place using the localizer from the context. For each FieldError, looks up the key "validation-" + tag (e.g., "validation-required"). If a translation is found, replaces Message; otherwise preserves the original English message.

Static Files Helpers¶

Defined in github.com/oliverandrich/burrow/contrib/staticfiles.

URL¶

func URL(ctx context.Context, name string) string

Returns the content-hashed URL for a static file. Falls back to the original name if the file is not in the manifest or the middleware is not active.