foundation

package
v1.18.0 Latest Latest
Warning

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

Go to latest
Published: Jul 4, 2026 License: MIT Imports: 63 Imported by: 14

Documentation

Index

Constants

This section is empty.

Variables

Functions

func NewApplication added in v1.12.0

func NewApplication() foundation.Application

func Setup added in v1.17.0

Types

type Application

type Application struct {
	*Container
	// contains filtered or unexported fields
}

func (*Application) About added in v1.15.0

func (r *Application) About(section string, items []foundation.AboutItem)

func (*Application) BasePath added in v1.12.0

func (r *Application) BasePath(paths ...string) string

func (*Application) Boot

func (r *Application) Boot()

func (*Application) BootstrapPath added in v1.17.0

func (r *Application) BootstrapPath(paths ...string) string

func (*Application) Build added in v1.17.0

func (r *Application) Build() foundation.Application

func (*Application) Commands added in v1.12.0

func (r *Application) Commands(commands []contractsconsole.Command)

func (*Application) CommandsFilter added in v1.18.0

func (r *Application) CommandsFilter() []string

CommandsFilter returns the positive-list of command signatures to keep. nil means no filter is applied. Used by the console service provider so its own command batch goes through the same gate as the framework's defaultCommands batch.

func (*Application) ConfigPath added in v1.12.0

func (r *Application) ConfigPath(paths ...string) string

func (*Application) Context added in v1.17.0

func (r *Application) Context() context.Context

func (*Application) CurrentLocale added in v1.14.0

func (r *Application) CurrentLocale(ctx context.Context) string

func (*Application) DatabasePath added in v1.12.0

func (r *Application) DatabasePath(paths ...string) string

func (*Application) ExecutablePath added in v1.14.0

func (r *Application) ExecutablePath(paths ...string) string

func (*Application) FacadesPath added in v1.15.12

func (r *Application) FacadesPath(paths ...string) string

func (*Application) GetJson added in v1.14.0

func (r *Application) GetJson() foundation.Json

GetJson get the JSON implementation. DEPRECATED, use Json instead.

func (*Application) IsLocale added in v1.14.0

func (r *Application) IsLocale(ctx context.Context, locale string) bool

func (*Application) Json added in v1.17.0

func (r *Application) Json() foundation.Json

func (*Application) LangPath added in v1.14.0

func (r *Application) LangPath(paths ...string) string

func (*Application) ModelPath added in v1.17.0

func (r *Application) ModelPath(paths ...string) string

func (*Application) Path added in v1.12.0

func (r *Application) Path(paths ...string) string

func (*Application) PublicPath added in v1.12.0

func (r *Application) PublicPath(paths ...string) string

func (*Application) Publishes added in v1.12.0

func (r *Application) Publishes(packageName string, paths map[string]string, groups ...string)

func (*Application) Refresh added in v1.15.8

func (r *Application) Refresh()

func (*Application) RegisterBaseServiceProviders added in v1.17.0

func (r *Application) RegisterBaseServiceProviders()

func (*Application) ResourcePath added in v1.15.12

func (r *Application) ResourcePath(paths ...string) string

func (*Application) Restart added in v1.17.0

func (r *Application) Restart() error

func (*Application) SetBuilder added in v1.17.0

func (*Application) SetJson added in v1.14.0

func (r *Application) SetJson(j foundation.Json)

func (*Application) SetLocale added in v1.14.0

func (r *Application) SetLocale(ctx context.Context, locale string) context.Context

func (*Application) Shutdown added in v1.17.0

func (r *Application) Shutdown() error

func (*Application) Start added in v1.17.0

func (r *Application) Start()

func (*Application) StoragePath added in v1.12.0

func (r *Application) StoragePath(paths ...string) string

func (*Application) Version added in v1.14.0

func (r *Application) Version() string

type ApplicationBuilder added in v1.17.0

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

func NewApplicationBuilder added in v1.17.0

func NewApplicationBuilder(app foundation.Application) *ApplicationBuilder

func (*ApplicationBuilder) Create added in v1.17.0

func (*ApplicationBuilder) WithCallback added in v1.17.0

func (r *ApplicationBuilder) WithCallback(callback func()) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithCommands added in v1.17.0

func (r *ApplicationBuilder) WithCommands(fn func() []console.Command) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithCommandsFilter added in v1.18.0

func (r *ApplicationBuilder) WithCommandsFilter(fn func() []string) foundation.ApplicationBuilder

WithCommandsFilter registers a callback that returns the positive list of command signatures to keep when the framework registers Artisan commands. The callback runs once at Build() time.

Matching is signature-only (category never consulted):

  • Entries without '*' are exact-matched against command.Signature().
  • Entries containing '*' use glob matching via path.Match against command.Signature() (only '*' triggers the glob path; '?' is matched literally as an exact match).

Semantics:

  • Method not called → keep every command (default).
  • Callback returns nil → keep every command (no filter).
  • Callback returns []string{} → drop every command.
  • Callback returns entries → keep only commands matching an entry.

func (*ApplicationBuilder) WithConfig added in v1.17.0

func (r *ApplicationBuilder) WithConfig(fn func()) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithEvents added in v1.17.0

func (r *ApplicationBuilder) WithEvents(fn func() map[event.Event][]event.Listener) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithFilters added in v1.17.0

func (*ApplicationBuilder) WithGrpcClientCredentials added in v1.18.0

func (r *ApplicationBuilder) WithGrpcClientCredentials(fn func() map[string]credentials.TransportCredentials) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithGrpcClientInterceptors added in v1.17.0

func (r *ApplicationBuilder) WithGrpcClientInterceptors(fn func() map[string][]grpc.UnaryClientInterceptor) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithGrpcClientStatsHandlers added in v1.17.0

func (r *ApplicationBuilder) WithGrpcClientStatsHandlers(fn func() map[string][]stats.Handler) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithGrpcServerCredentials added in v1.18.0

func (r *ApplicationBuilder) WithGrpcServerCredentials(fn func() credentials.TransportCredentials) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithGrpcServerInterceptors added in v1.17.0

func (r *ApplicationBuilder) WithGrpcServerInterceptors(fn func() []grpc.UnaryServerInterceptor) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithGrpcServerStatsHandlers added in v1.17.0

func (r *ApplicationBuilder) WithGrpcServerStatsHandlers(fn func() []stats.Handler) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithJobs added in v1.17.0

func (r *ApplicationBuilder) WithJobs(fn func() []queue.Job) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithMiddleware added in v1.17.0

func (*ApplicationBuilder) WithMigrations added in v1.17.0

func (r *ApplicationBuilder) WithMigrations(fn func() []schema.Migration) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithPaths added in v1.17.0

func (*ApplicationBuilder) WithProviders added in v1.17.0

func (*ApplicationBuilder) WithRouting added in v1.17.0

func (r *ApplicationBuilder) WithRouting(fn func()) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithRules added in v1.17.0

func (*ApplicationBuilder) WithRunners added in v1.17.0

func (*ApplicationBuilder) WithSchedule added in v1.17.0

func (r *ApplicationBuilder) WithSchedule(fn func() []schedule.Event) foundation.ApplicationBuilder

func (*ApplicationBuilder) WithSeeders added in v1.17.0

func (r *ApplicationBuilder) WithSeeders(fn func() []seeder.Seeder) foundation.ApplicationBuilder

type BindingNotFoundError added in v1.18.0

type BindingNotFoundError struct {
	Key any
}

func NewBindingNotFoundError added in v1.18.0

func NewBindingNotFoundError(key any) *BindingNotFoundError

func (*BindingNotFoundError) Error added in v1.18.0

func (r *BindingNotFoundError) Error() string

type Container added in v1.12.0

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

func NewContainer added in v1.12.0

func NewContainer() *Container

func (*Container) Bind added in v1.12.0

func (r *Container) Bind(key any, callback func(app contractsfoundation.Application) (any, error))

func (*Container) BindWith added in v1.12.0

func (r *Container) BindWith(key any, callback func(app contractsfoundation.Application, parameters map[string]any) (any, error))

func (*Container) Bindings added in v1.15.12

func (r *Container) Bindings() []any

func (*Container) Fresh added in v1.15.8

func (r *Container) Fresh(bindings ...any)

func (*Container) Instance added in v1.12.0

func (r *Container) Instance(key any, ins any)

func (*Container) Make added in v1.12.0

func (r *Container) Make(key any) (any, error)

func (*Container) MakeAI added in v1.18.0

func (r *Container) MakeAI() contractsai.AI

func (*Container) MakeArtisan added in v1.12.0

func (r *Container) MakeArtisan() contractsconsole.Artisan

func (*Container) MakeAuth added in v1.12.0

func (r *Container) MakeAuth(ctx ...contractshttp.Context) contractsauth.Auth

func (*Container) MakeCache added in v1.12.0

func (r *Container) MakeCache() contractscache.Cache

func (*Container) MakeConfig added in v1.12.0

func (r *Container) MakeConfig() contractsconfig.Config

func (*Container) MakeCrypt added in v1.12.0

func (r *Container) MakeCrypt() contractscrypt.Crypt

func (*Container) MakeDB added in v1.15.12

func (r *Container) MakeDB() contractsdb.DB

func (*Container) MakeEvent added in v1.12.0

func (r *Container) MakeEvent() contractsevent.Instance

func (*Container) MakeGate added in v1.12.0

func (r *Container) MakeGate() contractsaccess.Gate

func (*Container) MakeGrpc added in v1.12.0

func (r *Container) MakeGrpc() contractsgrpc.Grpc

func (*Container) MakeHash added in v1.12.0

func (r *Container) MakeHash() contractshash.Hash

func (*Container) MakeHttp added in v1.15.12

func (r *Container) MakeHttp() contractshttpclient.Factory

func (*Container) MakeLang added in v1.14.0

func (*Container) MakeLog added in v1.12.0

func (r *Container) MakeLog() contractslog.Log

func (*Container) MakeMail added in v1.12.0

func (r *Container) MakeMail() contractsmail.Mail

func (*Container) MakeOrm added in v1.12.0

func (r *Container) MakeOrm() contractsorm.Orm

func (*Container) MakeProcess added in v1.17.0

func (r *Container) MakeProcess() contractsprocess.Process

func (*Container) MakeQueue added in v1.12.0

func (r *Container) MakeQueue() contractsqueue.Queue

func (*Container) MakeRateLimiter added in v1.12.0

func (r *Container) MakeRateLimiter() contractshttp.RateLimiter

func (*Container) MakeRoute added in v1.12.0

func (r *Container) MakeRoute() contractsroute.Route

func (*Container) MakeSchedule added in v1.12.0

func (r *Container) MakeSchedule() contractsschedule.Schedule

func (*Container) MakeSchema added in v1.15.0

func (r *Container) MakeSchema() contractsmigration.Schema

func (*Container) MakeSeeder added in v1.12.6

func (r *Container) MakeSeeder() contractsseerder.Facade

func (*Container) MakeSession added in v1.14.0

func (r *Container) MakeSession() contractsession.Manager

func (*Container) MakeStorage added in v1.12.0

func (r *Container) MakeStorage() contractsfilesystem.Storage

func (*Container) MakeTelemetry added in v1.17.0

func (r *Container) MakeTelemetry() contractstelemetry.Telemetry

func (*Container) MakeTesting added in v1.13.0

func (r *Container) MakeTesting() contractstesting.Testing

func (*Container) MakeValidation added in v1.12.0

func (r *Container) MakeValidation() contractsvalidation.Validation

func (*Container) MakeView added in v1.13.1

func (r *Container) MakeView() contractsview.View

func (*Container) MakeWith added in v1.12.0

func (r *Container) MakeWith(key any, parameters map[string]any) (any, error)

func (*Container) Singleton added in v1.12.0

func (r *Container) Singleton(key any, callback func(app contractsfoundation.Application) (any, error))

type ProviderRepository added in v1.17.0

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

func NewProviderRepository added in v1.17.0

func NewProviderRepository() *ProviderRepository

func (*ProviderRepository) Add added in v1.17.0

func (r *ProviderRepository) Add(providers []foundation.ServiceProvider)

func (*ProviderRepository) Boot added in v1.17.0

func (*ProviderRepository) GetBooted added in v1.17.0

func (*ProviderRepository) LoadFromConfig added in v1.17.0

func (r *ProviderRepository) LoadFromConfig(config config.Config) []foundation.ServiceProvider

func (*ProviderRepository) Register added in v1.17.0

func (*ProviderRepository) Reset added in v1.17.0

func (r *ProviderRepository) Reset()

type ProviderState added in v1.17.0

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

type RunnerWithInfo added in v1.17.0

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL