appcontext

Documentation

Overview

Package appcontext provides functionality to pass data in contexts through the lifetime of a web request.

Index

• func ContextWithData(ctx context.Context, appData Data) context.Context
• func ContextWithSession(ctx context.Context, data *Session) context.Context
• type Data
  • func DataFromContext(ctx context.Context) Data
  • func (d Data) EncodeQuery() string
  • func (d Data) IsAdmin() bool
  • func (d Data) IsAttorneyType() bool
  • func (d Data) IsCertificateProvider() bool
  • func (d Data) IsDonor() bool
  • func (d Data) IsReplacementAttorney() bool
  • func (d Data) IsTrustCorporation() bool
  • func (d Data) Redirect(w http.ResponseWriter, r *http.Request, url string) error
• type Localizer
• type Session
  • func SessionFromContext(ctx context.Context) (*Session, error)
• type SessionMissingError
  • func (s SessionMissingError) Error() string
• type SupporterData

Functions

func ContextWithData

func ContextWithData(ctx context.Context, appData Data) context.Context

func ContextWithSession

func ContextWithSession(ctx context.Context, data *Session) context.Context

Types

type Data

type Data struct {
	Page              string
	Path              string
	Query             url.Values
	Localizer         Localizer
	Lang              localize.Lang
	CookieConsentSet  bool
	CanGoBack         bool
	CanToggleWelsh    bool
	SessionID         string
	LpaID             string
	CsrfToken         string
	ActorType         actor.Type
	AttorneyUID       actoruid.UID
	LoginSessionEmail string
	SupporterData     *SupporterData
}

func DataFromContext

func DataFromContext(ctx context.Context) Data

func (Data) EncodeQuery

func (d Data) EncodeQuery() string

func (Data) IsAdmin

func (d Data) IsAdmin() bool

func (Data) IsAttorneyType

func (d Data) IsAttorneyType() bool

func (Data) IsCertificateProvider

func (d Data) IsCertificateProvider() bool

func (Data) IsDonor

func (d Data) IsDonor() bool

func (Data) IsReplacementAttorney

func (d Data) IsReplacementAttorney() bool

func (Data) IsTrustCorporation

func (d Data) IsTrustCorporation() bool

func (Data) Redirect

func (d Data) Redirect(w http.ResponseWriter, r *http.Request, url string) error

type Localizer

type Localizer interface {
	Concat(list []string, joiner string) string
	Count(messageID string, count int) string
	Format(messageID string, data map[string]interface{}) string
	FormatCount(messageID string, count int, data map[string]any) string
	FormatDate(t date.TimeOrDate) string
	FormatTime(t time.Time) string
	FormatDateTime(t time.Time) string
	Possessive(s string) string
	SetShowTranslationKeys(s bool)
	ShowTranslationKeys() bool
	T(messageID string) string
}

type Session

type Session struct {
	SessionID string
	LpaID     string

	// if a supporter
	Email          string
	OrganisationID string
}

func SessionFromContext

func SessionFromContext(ctx context.Context) (*Session, error)

type SessionMissingError

type SessionMissingError struct{}

func (SessionMissingError) Error

func (s SessionMissingError) Error() string

type SupporterData

type SupporterData struct {
	LpaType              lpadata.LpaType
	DonorFullName        string
	OrganisationName     string
	IsManageOrganisation bool
	Permission           supporterdata.Permission
	LoggedInSupporterID  string
}