be

package module
v0.5.12 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 18, 2024 License: Apache-2.0 Imports: 56 Imported by: 4

README ¶

Go-Enjin

This package is the core of the Go-Enjin project and is named be mainly for artistic purposes. It can be thought of as an acronym with the b meaning "back" or "built" or whatever you like and the e meaning Enjin.

What is Enjin?

Enjin (noun), meaning an engine for doing things.

In the context of the Go-Enjin project, this is an engine for building servers and microservices.

Is it even a word?

No, the word enjin is not an actual word in any language, though it is an homage to Heroku (which is a really cool word and has its own backstory).

The word enjin consists of two main parts:

  • en, this was chosen for "English language", or "English speaking" (this must not to be confused with any countries, nationalities or personalities in any way)
  • jin, this was chosen for its roots in Japanese such as:
    • gaijin (meaning "foreigner" - which this author is) or
    • henjin (meaning "strange person" - which this author also is)

Author

LICENSE

All Go-Enjin projects are provided under the APACHE 2.0 license, as follows:

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
 
    http: www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Enjin ¶ 

type Enjin struct {
	// contains filtered or unexported fields
}

func (*Enjin) ApplyPageContextUpdaters ¶ added in v0.5.8 

func (e *Enjin) ApplyPageContextUpdaters(r *http.Request, pages ...feature.Page)

func (*Enjin) CheckMatchQL ¶ added in v0.1.0 

func (e *Enjin) CheckMatchQL(query string) (pages []feature.Page, err error)

func (*Enjin) CheckMatchStubsQL ¶ added in v0.1.0 

func (e *Enjin) CheckMatchStubsQL(query string) (stubs []*feature.PageStub, err error)

func (*Enjin) CheckSelectQL ¶ added in v0.1.0 

func (e *Enjin) CheckSelectQL(query string) (selected map[string]interface{}, err error)

func (*Enjin) Connect ¶ added in v0.2.2 

func (e *Enjin) Connect(signal signaling.Signal, handle string, l signaling.Listener, data ...interface{})

func (*Enjin) Consoles ¶ 

func (e *Enjin) Consoles() (consoles map[feature.Tag]feature.Console)

func (*Enjin) ContentSecurityPolicy ¶ 

func (e *Enjin) ContentSecurityPolicy() (handler *csp.PolicyHandler)

func (*Enjin) Context ¶ 

func (e *Enjin) Context(r *http.Request) (ctx context.Context)

func (*Enjin) CreateNonce ¶ added in v0.5.0 

func (e *Enjin) CreateNonce(key string) (value string)

func (*Enjin) CreateToken ¶ added in v0.5.0 

func (e *Enjin) CreateToken(key string) (value, shasum string)

func (*Enjin) CreateTokenWith ¶ added in v0.5.0 

func (e *Enjin) CreateTokenWith(key string, duration time.Duration) (value, shasum string)

func (*Enjin) DB ¶ 

func (e *Enjin) DB(tag string) (db interface{}, err error)

func (*Enjin) Disconnect ¶ added in v0.2.2 

func (e *Enjin) Disconnect(signal signaling.Signal, handle string)

func (*Enjin) Domains ¶ 

func (e *Enjin) Domains() (domains []string)

func (*Enjin) Emit ¶ added in v0.2.2 

func (e *Enjin) Emit(signal signaling.Signal, tag string, argv ...interface{}) (stopped bool)

func (*Enjin) Features ¶ 

func (e *Enjin) Features() (cache *feature.FeaturesCache)

func (*Enjin) FinalizeServeRequest ¶ added in v0.5.0 

func (e *Enjin) FinalizeServeRequest(w http.ResponseWriter, r *http.Request) (modified *http.Request)

func (*Enjin) FindAllUserActions ¶ added in v0.2.0 

func (e *Enjin) FindAllUserActions() (list feature.Actions)

func (*Enjin) FindEmailAccount ¶ added in v0.1.0 

func (e *Enjin) FindEmailAccount(account string) (emailSender feature.EmailSender)

func (*Enjin) FindFile ¶ added in v0.1.0 

func (e *Enjin) FindFile(path string) (data []byte, mime string, err error)

func (*Enjin) FindPage ¶ 

func (e *Enjin) FindPage(r *http.Request, tag language.Tag, url string) (p feature.Page)

func (*Enjin) FindPageStub ¶ added in v0.2.12 

func (e *Enjin) FindPageStub(shasum string) (stub *feature.PageStub)

func (*Enjin) FindPages ¶ 

func (e *Enjin) FindPages(prefix string) (pages []feature.Page)

func (*Enjin) FindRedirection ¶ 

func (e *Enjin) FindRedirection(url string) (p feature.Page)

func (*Enjin) FindTranslationUrls ¶ added in v0.5.0 

func (e *Enjin) FindTranslationUrls(url string) (pages map[language.Tag]string)

func (*Enjin) FindTranslations ¶ 

func (e *Enjin) FindTranslations(url string) (pages feature.Pages)

func (*Enjin) GetApplyMiddlewares ¶ added in v0.5.0 

func (e *Enjin) GetApplyMiddlewares() []feature.ApplyMiddleware

func (*Enjin) GetAuthProviders ¶ added in v0.5.0 

func (e *Enjin) GetAuthProviders() []feature.AuthProvider

func (*Enjin) GetContentSecurityPolicyModifiers ¶ added in v0.5.0 

func (e *Enjin) GetContentSecurityPolicyModifiers() []feature.ContentSecurityPolicyModifier

func (*Enjin) GetDataRestrictionHandlers ¶ added in v0.5.0 

func (e *Enjin) GetDataRestrictionHandlers() []feature.DataRestrictionHandler

func (*Enjin) GetDatabases ¶ added in v0.5.0 

func (e *Enjin) GetDatabases() []feature.Database

func (*Enjin) GetEmailSenders ¶ added in v0.5.0 

func (e *Enjin) GetEmailSenders() []feature.EmailSender

func (*Enjin) GetEnjinContextProvider ¶ added in v0.5.0 

func (e *Enjin) GetEnjinContextProvider() []feature.EnjinContextProvider

func (*Enjin) GetFileProviders ¶ added in v0.5.0 

func (e *Enjin) GetFileProviders() []feature.FileProvider

func (*Enjin) GetFinalizeServePagesFeatures ¶ added in v0.5.0 

func (e *Enjin) GetFinalizeServePagesFeatures() []feature.FinalizeServeRequestFeature

func (*Enjin) GetFormat ¶ 

func (e *Enjin) GetFormat(name string) (format feature.PageFormat)

func (*Enjin) GetFormatProviders ¶ added in v0.5.0 

func (e *Enjin) GetFormatProviders() []feature.PageFormatProvider

func (*Enjin) GetFuncMapProviders ¶ added in v0.5.0 

func (e *Enjin) GetFuncMapProviders() []feature.FuncMapProvider

func (*Enjin) GetHeadersModifiers ¶ added in v0.5.0 

func (e *Enjin) GetHeadersModifiers() []feature.HeadersModifier

func (*Enjin) GetLocaleHandler ¶ added in v0.5.0 

func (e *Enjin) GetLocaleHandler() feature.LocaleHandler

func (*Enjin) GetLocalesProviders ¶ added in v0.5.0 

func (e *Enjin) GetLocalesProviders() []feature.LocalesProvider

func (*Enjin) GetMenuProviders ¶ added in v0.5.0 

func (e *Enjin) GetMenuProviders() []feature.MenuProvider

func (*Enjin) GetOutputTransformers ¶ added in v0.5.0 

func (e *Enjin) GetOutputTransformers() []feature.OutputTransformer

func (*Enjin) GetOutputTranslators ¶ added in v0.5.0 

func (e *Enjin) GetOutputTranslators() []feature.OutputTranslator

func (*Enjin) GetPageContextFieldsProviders ¶ added in v0.5.0 

func (e *Enjin) GetPageContextFieldsProviders() []feature.PageContextFieldsProvider

func (*Enjin) GetPageContextModifiers ¶ added in v0.5.0 

func (e *Enjin) GetPageContextModifiers() []feature.PageContextModifier

func (*Enjin) GetPageContextParsersProviders ¶ added in v0.5.0 

func (e *Enjin) GetPageContextParsersProviders() []feature.PageContextParsersProvider

func (*Enjin) GetPageContextProviders ¶ added in v0.5.0 

func (e *Enjin) GetPageContextProviders() []feature.PageContextProvider

func (*Enjin) GetPageContextUpdaters ¶ added in v0.5.0 

func (e *Enjin) GetPageContextUpdaters() []feature.PageContextUpdater

func (*Enjin) GetPageProviders ¶ added in v0.5.0 

func (e *Enjin) GetPageProviders() []feature.PageProvider

func (*Enjin) GetPageRestrictionHandlers ¶ added in v0.5.0 

func (e *Enjin) GetPageRestrictionHandlers() []feature.PageRestrictionHandler

func (*Enjin) GetPageShortcodeProcessors ¶ added in v0.5.0 

func (e *Enjin) GetPageShortcodeProcessors() []feature.PageShortcodeProcessor

func (*Enjin) GetPageTypeProcessors ¶ added in v0.5.0 

func (e *Enjin) GetPageTypeProcessors() []feature.PageTypeProcessor

func (*Enjin) GetPanicHandler ¶ added in v0.5.0 

func (e *Enjin) GetPanicHandler() feature.PanicHandler

func (*Enjin) GetPermissionsPolicyModifiers ¶ added in v0.5.0 

func (e *Enjin) GetPermissionsPolicyModifiers() []feature.PermissionsPolicyModifier

func (*Enjin) GetPrepareServePagesFeatures ¶ added in v0.5.0 

func (e *Enjin) GetPrepareServePagesFeatures() []feature.PrepareServePagesFeature

func (*Enjin) GetProcessors ¶ added in v0.5.0 

func (e *Enjin) GetProcessors() []feature.Processor

func (*Enjin) GetPublicAccess ¶ added in v0.2.0 

func (e *Enjin) GetPublicAccess() (actions feature.Actions)

func (*Enjin) GetQueryIndexFeatures ¶ added in v0.5.0 

func (e *Enjin) GetQueryIndexFeatures() []feature.QueryIndexFeature

func (*Enjin) GetRequestFilters ¶ added in v0.5.0 

func (e *Enjin) GetRequestFilters() []feature.RequestFilter

func (*Enjin) GetRequestModifiers ¶ added in v0.5.0 

func (e *Enjin) GetRequestModifiers() []feature.RequestModifier

func (*Enjin) GetRequestRewriters ¶ added in v0.5.0 

func (e *Enjin) GetRequestRewriters() []feature.RequestRewriter

func (*Enjin) GetRoutePagesHandler ¶ added in v0.5.0 

func (e *Enjin) GetRoutePagesHandler() feature.RoutePagesHandler

func (*Enjin) GetServePagesHandler ¶ added in v0.5.0 

func (e *Enjin) GetServePagesHandler() feature.ServePagesHandler

func (*Enjin) GetServePathFeatures ¶ added in v0.5.0 

func (e *Enjin) GetServePathFeatures() []feature.ServePathFeature

func (*Enjin) GetServiceListener ¶ added in v0.5.0 

func (e *Enjin) GetServiceListener() feature.ServiceListener

func (*Enjin) GetServiceLogHandler ¶ added in v0.5.0 

func (e *Enjin) GetServiceLogHandler() feature.ServiceLogHandler

func (*Enjin) GetServiceLoggers ¶ added in v0.5.0 

func (e *Enjin) GetServiceLoggers() []feature.ServiceLogger

func (*Enjin) GetTemplatePartial ¶ added in v0.4.0 

func (e *Enjin) GetTemplatePartial(block, position, name string) (tmpl string, ok bool)

func (*Enjin) GetTemplatePartialsProvider ¶ added in v0.5.0 

func (e *Enjin) GetTemplatePartialsProvider() []feature.TemplatePartialsProvider

func (*Enjin) GetTheme ¶ 

func (e *Enjin) GetTheme() (t feature.Theme, err error)

func (*Enjin) GetThemeName ¶ added in v0.5.0 

func (e *Enjin) GetThemeName() (name string)

func (*Enjin) GetThemeNamed ¶ added in v0.5.0 

func (e *Enjin) GetThemeNamed(name string) (t feature.Theme, err error)

func (*Enjin) GetThemeRenderer ¶ added in v0.4.0 

func (e *Enjin) GetThemeRenderer(ctx context.Context) (renderer feature.ThemeRenderer)

func (*Enjin) GetThemeRenderers ¶ added in v0.5.0 

func (e *Enjin) GetThemeRenderers() []feature.ThemeRenderer

func (*Enjin) GetUseMiddlewares ¶ added in v0.5.0 

func (e *Enjin) GetUseMiddlewares() []feature.UseMiddleware

func (*Enjin) GetUserActionsProviders ¶ added in v0.5.0 

func (e *Enjin) GetUserActionsProviders() []feature.UserActionsProvider

func (*Enjin) Headers ¶ 

func (e *Enjin) Headers() (headers []headers.ModifyHeadersFn)

func (*Enjin) HotReloading ¶ added in v0.5.0 

func (e *Enjin) HotReloading() (enabled bool)

func (*Enjin) ListFormats ¶ added in v0.1.0 

func (e *Enjin) ListFormats() (names []string)

func (*Enjin) ListTemplatePartials ¶ added in v0.4.0 

func (e *Enjin) ListTemplatePartials(block, position string) (names []string)

func (*Enjin) MakeFuncMap ¶ added in v0.4.0 

func (e *Enjin) MakeFuncMap(ctx context.Context) (fm feature.FuncMap)

func (*Enjin) MakeLanguagePrinter ¶ added in v0.5.0 

func (e *Enjin) MakeLanguagePrinter(requested string) (tag language.Tag, printer *message.Printer)

func (*Enjin) MakePageContextField ¶ added in v0.5.0 

func (e *Enjin) MakePageContextField(key string, r *http.Request) (field *context.Field, ok bool)

func (*Enjin) MakePageContextFields ¶ added in v0.5.0 

func (e *Enjin) MakePageContextFields(r *http.Request) (fields context.Fields)

func (*Enjin) MatchFormat ¶ 

func (e *Enjin) MatchFormat(filename string) (format feature.PageFormat, match string)

func (*Enjin) MatchQL ¶ 

func (e *Enjin) MatchQL(query string) (pages []feature.Page)

func (*Enjin) MatchStubsQL ¶ 

func (e *Enjin) MatchStubsQL(query string) (stubs []*feature.PageStub)

func (*Enjin) MustDB ¶ 

func (e *Enjin) MustDB(tag string) (db interface{})

func (*Enjin) MustGetTheme ¶ added in v0.1.0 

func (e *Enjin) MustGetTheme() (t feature.Theme)

func (*Enjin) MustGetThemeNamed ¶ added in v0.5.0 

func (e *Enjin) MustGetThemeNamed(name string) (t feature.Theme)

func (*Enjin) MustSpecificDB ¶ 

func (e *Enjin) MustSpecificDB(fTag feature.Tag, tag string) (db interface{})

func (*Enjin) NewSyncLocker ¶ added in v0.5.0 

func (e *Enjin) NewSyncLocker(tag feature.Tag, key string, store feature.KeyValueStore) (l feature.SyncLocker)

func (*Enjin) NewSyncLockerWith ¶ added in v0.5.0 

func (e *Enjin) NewSyncLockerWith(tag feature.Tag, key string, store feature.KeyValueStore, timeout, interval time.Duration) (l feature.SyncLocker)

func (*Enjin) NewSyncRWLocker ¶ added in v0.5.0 

func (e *Enjin) NewSyncRWLocker(tag feature.Tag, key string, readStore, writeStore feature.KeyValueStore) (l feature.SyncRWLocker)

func (*Enjin) NewSyncRWLockerWith ¶ added in v0.5.0 

func (e *Enjin) NewSyncRWLockerWith(tag feature.Tag, key string, readStore, writeStore feature.KeyValueStore, timeout, interval time.Duration) (l feature.SyncRWLocker)

func (*Enjin) Notify ¶ 

func (e *Enjin) Notify(tag string)

func (*Enjin) NotifyF ¶ 

func (e *Enjin) NotifyF(tag, format string, argv ...interface{})

func (*Enjin) PageContextParsers ¶ added in v0.5.0 

func (e *Enjin) PageContextParsers() (parsers context.Parsers)

func (*Enjin) Pages ¶ 

func (e *Enjin) Pages() (pages map[string]feature.Page)

func (*Enjin) PermissionsPolicy ¶ 

func (e *Enjin) PermissionsPolicy() (handler *permissions.PolicyHandler)

func (*Enjin) Prefix ¶ 

func (e *Enjin) Prefix() (prefix string)

func (*Enjin) Processors ¶ 

func (e *Enjin) Processors() (processors map[string]feature.ReqProcessFn)

func (*Enjin) PublicFileSystems ¶ added in v0.4.0 

func (e *Enjin) PublicFileSystems() (registry fs.Registry)

func (*Enjin) PublicUserActions ¶ added in v0.5.0 

func (e *Enjin) PublicUserActions() (actions feature.Actions)

func (*Enjin) ReloadLocales ¶ added in v0.5.0 

func (e *Enjin) ReloadLocales()

func (*Enjin) Router ¶ 

func (e *Enjin) Router() (router *chi.Mux)

func (*Enjin) Run ¶ 

func (e *Enjin) Run(argv []string) (err error)

func (*Enjin) SelectQL ¶ 

func (e *Enjin) SelectQL(query string) (selected map[string]interface{})

func (*Enjin) Self ¶ 

func (e *Enjin) Self() (self interface{})

func (*Enjin) SendEmail ¶ added in v0.1.0 

func (e *Enjin) SendEmail(r *http.Request, account string, message *gomail.Message) (err error)

func (*Enjin) Serve204 ¶ 

func (e *Enjin) Serve204(w http.ResponseWriter, r *http.Request)

func (*Enjin) Serve400 ¶ added in v0.2.2 

func (e *Enjin) Serve400(w http.ResponseWriter, r *http.Request)

func (*Enjin) Serve401 ¶ 

func (e *Enjin) Serve401(w http.ResponseWriter, r *http.Request)

func (*Enjin) Serve403 ¶ 

func (e *Enjin) Serve403(w http.ResponseWriter, r *http.Request)

func (*Enjin) Serve404 ¶ 

func (e *Enjin) Serve404(w http.ResponseWriter, r *http.Request)

func (*Enjin) Serve405 ¶ 

func (e *Enjin) Serve405(w http.ResponseWriter, r *http.Request)

func (*Enjin) Serve500 ¶ 

func (e *Enjin) Serve500(w http.ResponseWriter, r *http.Request)

func (*Enjin) ServeBasic401 ¶ 

func (e *Enjin) ServeBasic401(w http.ResponseWriter, r *http.Request)

func (*Enjin) ServeData ¶ 

func (e *Enjin) ServeData(data []byte, mime string, w http.ResponseWriter, r *http.Request)

func (*Enjin) ServeForbidden ¶ added in v0.5.0 

func (e *Enjin) ServeForbidden(w http.ResponseWriter, r *http.Request)

func (*Enjin) ServeHtmlRedirect ¶ added in v0.5.4 

func (e *Enjin) ServeHtmlRedirect(destination string, w http.ResponseWriter, r *http.Request)

func (*Enjin) ServeInternalServerError ¶ 

func (e *Enjin) ServeInternalServerError(w http.ResponseWriter, r *http.Request)

func (*Enjin) ServeJSON ¶ added in v0.2.0 

func (e *Enjin) ServeJSON(v interface{}, w http.ResponseWriter, r *http.Request) (err error)

func (*Enjin) ServeNotFound ¶ 

func (e *Enjin) ServeNotFound(w http.ResponseWriter, r *http.Request)

func (*Enjin) ServePage ¶ 

func (e *Enjin) ServePage(p feature.Page, w http.ResponseWriter, r *http.Request) (err error)

func (*Enjin) ServePath ¶ 

func (e *Enjin) ServePath(urlPath string, w http.ResponseWriter, r *http.Request) (err error)

func (*Enjin) ServeRedirect ¶ 

func (e *Enjin) ServeRedirect(destination string, w http.ResponseWriter, r *http.Request)

func (*Enjin) ServeRedirectHomePath ¶ added in v0.5.0 

func (e *Enjin) ServeRedirectHomePath(w http.ResponseWriter, r *http.Request)

func (*Enjin) ServeStatusJSON ¶ added in v0.2.2 

func (e *Enjin) ServeStatusJSON(status int, v interface{}, w http.ResponseWriter, r *http.Request) (err error)

func (*Enjin) ServeStatusPage ¶ 

func (e *Enjin) ServeStatusPage(status int, w http.ResponseWriter, r *http.Request)

func (*Enjin) ServerName ¶ 

func (e *Enjin) ServerName() (name string)

func (*Enjin) ServiceInfo ¶ 

func (e *Enjin) ServiceInfo() (scheme, listen string, port int)

func (*Enjin) SetupRootEnjin ¶ 

func (e *Enjin) SetupRootEnjin(ctx *cli.Context) (err error)

func (*Enjin) Shutdown ¶ 

func (e *Enjin) Shutdown()

func (*Enjin) SiteCopyrightName ¶ added in v0.5.1 

func (e *Enjin) SiteCopyrightName() (name string)

func (*Enjin) SiteCopyrightNotice ¶ added in v0.5.1 

func (e *Enjin) SiteCopyrightNotice() (notice string)

func (*Enjin) SiteCopyrightYear ¶ added in v0.5.1 

func (e *Enjin) SiteCopyrightYear() (year string)

func (*Enjin) SiteDefaultLanguage ¶ 

func (e *Enjin) SiteDefaultLanguage() (tag language.Tag)

func (*Enjin) SiteLanguageCatalog ¶ 

func (e *Enjin) SiteLanguageCatalog() (c catalog.Catalog)

func (*Enjin) SiteLanguageDisplayName ¶ 

func (e *Enjin) SiteLanguageDisplayName(tag language.Tag) (name string, ok bool)

func (*Enjin) SiteLanguageMode ¶ 

func (e *Enjin) SiteLanguageMode() (mode lang.Mode)

func (*Enjin) SiteLocales ¶ 

func (e *Enjin) SiteLocales() (locales cllang.Tags)

func (*Enjin) SiteName ¶ 

func (e *Enjin) SiteName() (name string)

func (*Enjin) SiteSupportsLanguage ¶ 

func (e *Enjin) SiteSupportsLanguage(tag language.Tag) (supported bool)

func (*Enjin) SiteTag ¶ 

func (e *Enjin) SiteTag() (tag string)

func (*Enjin) SiteTagLine ¶ 

func (e *Enjin) SiteTagLine() (tagLine string)

func (*Enjin) Slugsums ¶ 

func (e *Enjin) Slugsums() (enabled bool)

func (*Enjin) SpecificDB ¶ 

func (e *Enjin) SpecificDB(fTag feature.Tag, tag string) (db interface{}, err error)

func (*Enjin) StartupString ¶ 

func (e *Enjin) StartupString() string

func (*Enjin) String ¶ 

func (e *Enjin) String() string

func (*Enjin) Theme ¶ 

func (e *Enjin) Theme() (theme string)

func (*Enjin) ThemeNames ¶ 

func (e *Enjin) ThemeNames() (names []string)

func (*Enjin) Theming ¶ 

func (e *Enjin) Theming() (theming map[string]feature.Theme)

func (*Enjin) Transformers ¶ 

func (e *Enjin) Transformers() (transformers map[string]feature.TransformOutputFn)

func (*Enjin) TranslateShortcodes ¶ added in v0.4.0 

func (e *Enjin) TranslateShortcodes(content string, ctx context.Context) (modified string)

func (*Enjin) Translators ¶ 

func (e *Enjin) Translators() (translators map[string]feature.TranslateOutputFn)

func (*Enjin) ValidateUserRequest ¶ added in v0.5.0 

func (e *Enjin) ValidateUserRequest(action feature.Action, w http.ResponseWriter, r *http.Request) (valid bool)

func (*Enjin) VerifyNonce ¶ added in v0.5.0 

func (e *Enjin) VerifyNonce(key, value string) (valid bool)

func (*Enjin) VerifyToken ¶ added in v0.5.0 

func (e *Enjin) VerifyToken(key, value string) (valid bool)

type EnjinBuilder ¶ 

type EnjinBuilder struct {
	signaling.CSignaling
	// contains filtered or unexported fields
}

func New ¶ 

func New() (be *EnjinBuilder)

func (*EnjinBuilder) AddCommands ¶ 

func (eb *EnjinBuilder) AddCommands(commands ...*cli.Command) feature.Builder

func (*EnjinBuilder) AddConsole ¶ 

func (eb *EnjinBuilder) AddConsole(c feature.Console) feature.Builder

func (*EnjinBuilder) AddCspModifierFn ¶ added in v0.5.1 

func (eb *EnjinBuilder) AddCspModifierFn(tag string, fn feature.CspModifierFn) feature.Builder

func (*EnjinBuilder) AddDomains ¶ 

func (eb *EnjinBuilder) AddDomains(domains ...string) feature.Builder

func (*EnjinBuilder) AddFeature ¶ 

func (eb *EnjinBuilder) AddFeature(features ...feature.Feature) feature.Builder

func (*EnjinBuilder) AddFlags ¶ 

func (eb *EnjinBuilder) AddFlags(flags ...cli.Flag) feature.Builder

func (*EnjinBuilder) AddHtmlHeadTag ¶ 

func (eb *EnjinBuilder) AddHtmlHeadTag(name string, attr map[string]string) feature.Builder

func (*EnjinBuilder) AddModifyHeadersFn ¶ 

func (eb *EnjinBuilder) AddModifyHeadersFn(fn headers.ModifyHeadersFn) feature.Builder

func (*EnjinBuilder) AddNotifyHook ¶ 

func (eb *EnjinBuilder) AddNotifyHook(name string, hook feature.NotifyHook) feature.Builder

func (*EnjinBuilder) AddOutputTransformer ¶ 

func (eb *EnjinBuilder) AddOutputTransformer(mime string, filter feature.TransformOutputFn) feature.Builder

func (*EnjinBuilder) AddOutputTranslator ¶ 

func (eb *EnjinBuilder) AddOutputTranslator(mime string, filter feature.TranslateOutputFn) feature.Builder

func (*EnjinBuilder) AddPageFromString ¶ 

func (eb *EnjinBuilder) AddPageFromString(path, raw string) feature.Builder

func (*EnjinBuilder) AddPreset ¶ added in v0.4.0 

func (eb *EnjinBuilder) AddPreset(presets ...feature.Preset) feature.Builder

func (*EnjinBuilder) AddRouteProcessor ¶ 

func (eb *EnjinBuilder) AddRouteProcessor(route string, processor feature.ReqProcessFn) feature.Builder

func (*EnjinBuilder) AddTheme ¶ 

func (eb *EnjinBuilder) AddTheme(t feature.Theme) feature.Builder

func (*EnjinBuilder) AddUserAction ¶ added in v0.2.1 

func (eb *EnjinBuilder) AddUserAction(actions ...feature.Action) feature.Builder

func (*EnjinBuilder) Build ¶ 

func (eb *EnjinBuilder) Build() feature.Runner

func (*EnjinBuilder) Features ¶ added in v0.5.0 

func (eb *EnjinBuilder) Features() (cache *feature.FeaturesCache)

func (*EnjinBuilder) HotReload ¶ 

func (eb *EnjinBuilder) HotReload(enabled bool) feature.Builder

func (*EnjinBuilder) IgnoreSlugsums ¶ 

func (eb *EnjinBuilder) IgnoreSlugsums() *EnjinBuilder

func (*EnjinBuilder) IncludeEnjin ¶ 

func (eb *EnjinBuilder) IncludeEnjin(enjins ...feature.Builder) feature.Builder

func (*EnjinBuilder) MakeEnvKey ¶ 

func (eb *EnjinBuilder) MakeEnvKey(name string) (key string)

func (*EnjinBuilder) MakeEnvKeys ¶ 

func (eb *EnjinBuilder) MakeEnvKeys(names ...string) (keys []string)

func (*EnjinBuilder) PrependFeature ¶ added in v0.4.0 

func (eb *EnjinBuilder) PrependFeature(f feature.Feature) feature.Builder

func (*EnjinBuilder) RegisterPublicFileSystem ¶ added in v0.4.0 

func (eb *EnjinBuilder) RegisterPublicFileSystem(mount string, filesystems ...fs.FileSystem)

func (*EnjinBuilder) RegisterTemplatePartial ¶ added in v0.4.0 

func (eb *EnjinBuilder) RegisterTemplatePartial(block, position, name, tmpl string) (err error)

func (*EnjinBuilder) Set ¶ 

func (eb *EnjinBuilder) Set(key string, value interface{}) feature.Builder

func (*EnjinBuilder) SetAlwaysHtmlRedirect ¶ added in v0.5.4 

func (eb *EnjinBuilder) SetAlwaysHtmlRedirect(always bool) feature.Builder

func (*EnjinBuilder) SetEnjinTextFn ¶ added in v0.5.1 

func (eb *EnjinBuilder) SetEnjinTextFn(fn feature.EnjinTextFn) feature.Builder

func (*EnjinBuilder) SetHtmlRedirectDelay ¶ added in v0.5.4 

func (eb *EnjinBuilder) SetHtmlRedirectDelay(seconds int) feature.Builder

func (*EnjinBuilder) SetPublicAccess ¶ added in v0.2.0 

func (eb *EnjinBuilder) SetPublicAccess(actions ...feature.Action) feature.Builder

func (*EnjinBuilder) SetStatusPage ¶ 

func (eb *EnjinBuilder) SetStatusPage(status int, path string) feature.Builder

func (*EnjinBuilder) SetTheme ¶ 

func (eb *EnjinBuilder) SetTheme(name string) feature.Builder

func (*EnjinBuilder) SiteCopyrightName ¶ 

func (eb *EnjinBuilder) SiteCopyrightName(name string) feature.Builder

func (*EnjinBuilder) SiteCopyrightNotice ¶ 

func (eb *EnjinBuilder) SiteCopyrightNotice(notice string) feature.Builder

func (*EnjinBuilder) SiteCopyrightYear ¶ added in v0.5.1 

func (eb *EnjinBuilder) SiteCopyrightYear(year string) feature.Builder

func (*EnjinBuilder) SiteDefaultLanguage ¶ 

func (eb *EnjinBuilder) SiteDefaultLanguage(tag language.Tag) feature.Builder

func (*EnjinBuilder) SiteLanguageDisplayNames ¶ 

func (eb *EnjinBuilder) SiteLanguageDisplayNames(names map[language.Tag]string) feature.Builder

func (*EnjinBuilder) SiteLanguageMode ¶ 

func (eb *EnjinBuilder) SiteLanguageMode(mode lang.Mode) feature.Builder

func (*EnjinBuilder) SiteName ¶ 

func (eb *EnjinBuilder) SiteName(name string) feature.Builder

func (*EnjinBuilder) SiteSupportedLanguages ¶ 

func (eb *EnjinBuilder) SiteSupportedLanguages(tags ...language.Tag) feature.Builder

func (*EnjinBuilder) SiteTag ¶ 

func (eb *EnjinBuilder) SiteTag(tag string) feature.Builder

func (*EnjinBuilder) SiteTagLine ¶ 

func (eb *EnjinBuilder) SiteTagLine(tagLine string) feature.Builder

Source Files ¶

View all Source files

Directories ¶

Path Synopsis
features
fs/locale
fs/site-users
pages/formats
pages/formats/bb
pages/formats/html
pages/formats/json
pages/formats/md
pages/formats/njn
pages/formats/njn/blocks/card
pages/formats/njn/blocks/carousel
pages/formats/njn/blocks/content
pages/formats/njn/blocks/header
pages/formats/njn/blocks/icon
pages/formats/njn/blocks/image
pages/formats/njn/blocks/index
pages/formats/njn/blocks/linkList
pages/formats/njn/blocks/notice
pages/formats/njn/blocks/pair
pages/formats/njn/blocks/sidebar
pages/formats/njn/blocks/toc
pages/formats/njn/fields/anchor
pages/formats/njn/fields/code
pages/formats/njn/fields/container
pages/formats/njn/fields/details
pages/formats/njn/fields/fa
pages/formats/njn/fields/fieldset
pages/formats/njn/fields/figure
pages/formats/njn/fields/footnote
pages/formats/njn/fields/img
pages/formats/njn/fields/inline
pages/formats/njn/fields/input
pages/formats/njn/fields/list
pages/formats/njn/fields/literal
pages/formats/njn/fields/optgroup
pages/formats/njn/fields/option
pages/formats/njn/fields/p
pages/formats/njn/fields/picture
pages/formats/njn/fields/pre
pages/formats/njn/fields/select
pages/formats/njn/fields/table
pages/formats/org
pages/formats/text
pages/formats/tmpl
pages/shortcodes
pages/tagcloud
Package tagcloud provides tag cloud enjin features
 Package tagcloud provides tag cloud enjin features
pages/tagcloud/njn-tagcloud
requests/pages/context-modifiers
requests/pages/i18n
requests/pages/policies
requests/pages/request
requests/pages/restrictions
requests/pages/sitemenus
site
site/auth
site/auth/otp/app_totp
site/auth/otp/backup_codes
site/auth/otp/email_hotp
site/auth/provider/email_backup
site/auth/provider/email_token
site/dashboard
site/fs-editor/enjin-info
site/fs-editor/locales
site/fs-editor/menus
site/fs-editor/pages
site/fs-editor/themes
site/fs-editor/unsafe
site/profile
site/settings
site/user-manager
srv/factories/nonces
srv/factories/spinlockers
srv/factories/tokens
srv/logging/handler
srv/logging/logger
srv/middleware/locales
srv/middleware/panics
srv/theme/renderer
user/base/ipenv
pkg
cli
cli/git
cli/run
cli/tar
cli/zip
cmp
context
crypto
deepcopy
editor
errors
factories/nonces
factories/tokens
feature
feature/filesystem
feature/signaling
feature/site-environ
feature/site-including
feature/site-secure-context
feature/uses-actions
feature/uses-enjin-salt
feature/uses-kvc
forms
fs
globals
gob
indexing/search
kvs
lang
lang/catalog
log
log/filelogwriter
maps
maps/kvm
menu
net
net/headers
net/headers/policy/csp
net/headers/policy/permissions
net/ip/ranges/atlassian
net/ip/ranges/cloudflare
net/minify
net/serve
notify
pageql
pages
path/embed
path/zip
profiling
regexps
request
request/argv
search
signals
slug
strings
userbase
presets
defaults
essentials
types
logging/context
logging/response
page
page/matter
site
site/fs-editor
theme
theme/layouts
users

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.