site

Documentation

Index

• Constants
• Variables
• type CFeature
  • func (f *CFeature) Apply(s feature.System) (err error)
  • func (f *CFeature) ApplyContext(eid string, changes context.Context)
  • func (f *CFeature) Build(b feature.Buildable) (err error)
  • func (f *CFeature) DeleteContextKeys(eid string, keys ...string)
  • func (f *CFeature) FinalizeServeRequest(w http.ResponseWriter, r *http.Request) (modified *http.Request)
  • func (f *CFeature) GetContext(eid string) (ctx context.Context)
  • func (f *CFeature) GetContextUnsafe(eid string) (ctx context.Context)
  • func (f *CFeature) IncludeSiteFeatures(features ...feature.Feature) MakeFeature
  • func (f *CFeature) IncludingSiteFeatures(tags ...feature.Tag) MakeFeature
  • func (f *CFeature) Init(this interface{})
  • func (f *CFeature) Make() (feat Feature)
  • func (f *CFeature) MustRequireVerification(verifyPath string, w http.ResponseWriter, r *http.Request) (allowed bool)
  • func (f *CFeature) PostStartup(ctx *cli.Context) (err error)
  • func (f *CFeature) PrepareAndServePage(layout, pageType, pagePath string, t feature.Theme, w http.ResponseWriter, ...) (err error)
  • func (f *CFeature) PreparePage(layout, pageType, pagePath string, t feature.Theme, r *http.Request) (pg feature.Page, ctx context.Context, err error)
  • func (f *CFeature) PullNotices(eid string) (notices feature.UserNotices)
  • func (f *CFeature) PushErrorNotice(eid string, dismiss bool, message string, argv ...interface{})
  • func (f *CFeature) PushImportantNotice(eid string, dismiss bool, message string, argv ...interface{})
  • func (f *CFeature) PushInfoNotice(eid string, dismiss bool, message string, argv ...interface{})
  • func (f *CFeature) PushNotices(eid string, notices ...*feature.UserNotice)
  • func (f *CFeature) PushWarnNotice(eid string, dismiss bool, message string, argv ...interface{})
  • func (f *CFeature) RequireVerification(verifyPath string, w http.ResponseWriter, r *http.Request) (allowed bool)
  • func (f *CFeature) ServePreparedPage(pg feature.Page, ctx context.Context, t feature.Theme, w http.ResponseWriter, ...)
  • func (f *CFeature) SetContext(eid string, ctx context.Context)
  • func (f *CFeature) SetContextUnsafe(eid string, ctx context.Context)
  • func (f *CFeature) SetSiteAuth(tag feature.Tag) MakeFeature
  • func (f *CFeature) SetSitePath(path string) MakeFeature
  • func (f *CFeature) SetSiteTheme(name string) MakeFeature
  • func (f *CFeature) SetSiteUsers(tag feature.Tag) MakeFeature
  • func (f *CFeature) SiteAuth() (sup feature.SiteAuthFeature)
  • func (f *CFeature) SiteFeatures() (list feature.SiteFeatures)
  • func (f *CFeature) SiteMenu(r *http.Request) (siteMenu context.Context)
  • func (f *CFeature) SitePath() (path string)
  • func (f *CFeature) SiteTheme() (t feature.Theme)
  • func (f *CFeature) SiteUsers() (sup feature.SiteUsersProvider)
  • func (f *CFeature) Startup(ctx *cli.Context) (err error)
  • func (f *CFeature) Use(s feature.System) feature.MiddlewareFn
  • func (f *CFeature) UseSiteRootFeature(feat feature.Feature) MakeFeature
  • func (f *CFeature) UserActions() (list feature.Actions)
  • func (f *CFeature) UsingSiteRootFeature(tag feature.Tag) MakeFeature
• type Feature
• type MakeFeature
  • func New() MakeFeature
  • func NewTagged(tag feature.Tag) MakeFeature

Constants

const Tag feature.Tag = "site-enjin"

Variables

var (
	DefaultSitePath = "/"
)

Types

type CFeature

type CFeature struct {
	feature.CFeature
	signaling.CSignaling
	uses_actions.CUsesActions
	uses_kvc.CUsesKVC[MakeFeature]
	// contains filtered or unexported fields
}

func (*CFeature) Apply

func (f *CFeature) Apply(s feature.System) (err error)

func (*CFeature) ApplyContext

func (f *CFeature) ApplyContext(eid string, changes context.Context)

func (*CFeature) Build

func (f *CFeature) Build(b feature.Buildable) (err error)

func (*CFeature) DeleteContextKeys

func (f *CFeature) DeleteContextKeys(eid string, keys ...string)

func (*CFeature) FinalizeServeRequest

func (f *CFeature) FinalizeServeRequest(w http.ResponseWriter, r *http.Request) (modified *http.Request)

func (*CFeature) GetContext

func (f *CFeature) GetContext(eid string) (ctx context.Context)

func (*CFeature) GetContextUnsafe

func (f *CFeature) GetContextUnsafe(eid string) (ctx context.Context)

func (*CFeature) IncludeSiteFeatures

func (f *CFeature) IncludeSiteFeatures(features ...feature.Feature) MakeFeature

func (*CFeature) IncludingSiteFeatures

func (f *CFeature) IncludingSiteFeatures(tags ...feature.Tag) MakeFeature

func (*CFeature) Init

func (f *CFeature) Init(this interface{})

func (*CFeature) Make

func (f *CFeature) Make() (feat Feature)

func (*CFeature) MustRequireVerification

func (f *CFeature) MustRequireVerification(verifyPath string, w http.ResponseWriter, r *http.Request) (allowed bool)

func (*CFeature) PostStartup

func (f *CFeature) PostStartup(ctx *cli.Context) (err error)

func (*CFeature) PrepareAndServePage

func (f *CFeature) PrepareAndServePage(layout, pageType, pagePath string, t feature.Theme, w http.ResponseWriter, r *http.Request, custom context.Context) (err error)

func (*CFeature) PreparePage

func (f *CFeature) PreparePage(layout, pageType, pagePath string, t feature.Theme, r *http.Request) (pg feature.Page, ctx context.Context, err error)

func (*CFeature) PullNotices

func (f *CFeature) PullNotices(eid string) (notices feature.UserNotices)

func (*CFeature) PushErrorNotice

func (f *CFeature) PushErrorNotice(eid string, dismiss bool, message string, argv ...interface{})

func (*CFeature) PushImportantNotice

func (f *CFeature) PushImportantNotice(eid string, dismiss bool, message string, argv ...interface{})

func (*CFeature) PushInfoNotice

func (f *CFeature) PushInfoNotice(eid string, dismiss bool, message string, argv ...interface{})

func (*CFeature) PushNotices

func (f *CFeature) PushNotices(eid string, notices ...*feature.UserNotice)

func (*CFeature) PushWarnNotice

func (f *CFeature) PushWarnNotice(eid string, dismiss bool, message string, argv ...interface{})

func (*CFeature) RequireVerification

func (f *CFeature) RequireVerification(verifyPath string, w http.ResponseWriter, r *http.Request) (allowed bool)

func (*CFeature) ServePreparedPage

func (f *CFeature) ServePreparedPage(pg feature.Page, ctx context.Context, t feature.Theme, w http.ResponseWriter, r *http.Request)

func (*CFeature) SetContext

func (f *CFeature) SetContext(eid string, ctx context.Context)

func (*CFeature) SetContextUnsafe

func (f *CFeature) SetContextUnsafe(eid string, ctx context.Context)

func (*CFeature) SetSiteAuth

func (f *CFeature) SetSiteAuth(tag feature.Tag) MakeFeature

func (*CFeature) SetSitePath

func (f *CFeature) SetSitePath(path string) MakeFeature

func (*CFeature) SetSiteTheme

func (f *CFeature) SetSiteTheme(name string) MakeFeature

func (*CFeature) SetSiteUsers

func (f *CFeature) SetSiteUsers(tag feature.Tag) MakeFeature

func (*CFeature) SiteAuth

func (f *CFeature) SiteAuth() (sup feature.SiteAuthFeature)

func (*CFeature) SiteFeatures

func (f *CFeature) SiteFeatures() (list feature.SiteFeatures)

func (*CFeature) SiteMenu

func (f *CFeature) SiteMenu(r *http.Request) (siteMenu context.Context)

func (*CFeature) SitePath

func (f *CFeature) SitePath() (path string)

func (*CFeature) SiteTheme

func (f *CFeature) SiteTheme() (t feature.Theme)

func (*CFeature) SiteUsers

func (f *CFeature) SiteUsers() (sup feature.SiteUsersProvider)

func (*CFeature) Startup

func (f *CFeature) Startup(ctx *cli.Context) (err error)

func (*CFeature) Use

func (f *CFeature) Use(s feature.System) feature.MiddlewareFn

func (*CFeature) UseSiteRootFeature

func (f *CFeature) UseSiteRootFeature(feat feature.Feature) MakeFeature

func (*CFeature) UserActions

func (f *CFeature) UserActions() (list feature.Actions)

func (*CFeature) UsingSiteRootFeature

func (f *CFeature) UsingSiteRootFeature(tag feature.Tag) MakeFeature

type Feature

type Feature interface {
	feature.Feature
	signaling.Signaling
	feature.Site
	feature.ApplyMiddleware
	feature.UserActionsProvider
	feature.FinalizeServeRequestFeature
}

type MakeFeature

type MakeFeature interface {
	uses_kvc.MakeFeature[MakeFeature]

	SetSitePath(path string) MakeFeature
	SetSiteTheme(name string) MakeFeature
	SetSiteUsers(tag feature.Tag) MakeFeature
	SetSiteAuth(tag feature.Tag) MakeFeature

	IncludeSiteFeatures(features ...feature.Feature) MakeFeature
	IncludingSiteFeatures(tags ...feature.Tag) MakeFeature

	UseSiteRootFeature(srf feature.Feature) MakeFeature
	UsingSiteRootFeature(tag feature.Tag) MakeFeature

	Make() Feature
}

func New

func New() MakeFeature

func NewTagged

func NewTagged(tag feature.Tag) MakeFeature