1. Documentation
  2. API
  3. Library
  4. Foundation
  5. Application

October\Rain\Foundation\Application

Overview

Application foundation class as an extension of Laravel

Extends
  • Illuminate\Foundation\Application
  • Illuminate\Container\Container
Implements
  • Symfony\Component\HttpKernel\HttpKernelInterface
  • Illuminate\Contracts\Foundation\CachesRoutes
  • Illuminate\Contracts\Foundation\CachesConfiguration
  • Illuminate\Contracts\Foundation\Application
  • Psr\Container\ContainerInterface
  • Illuminate\Contracts\Container\Container
  • ArrayAccess

Public Properties

There are no public properties in the class.

Show inherited public properties

Inherited Public Properties

  • $contextual - The contextual binding map. (defined in Illuminate\Container\Container)

Protected Properties

protected string $pluginsPath

pluginsPath is the base path for plugins

protected string $themesPath

themesPath is the base path for themes

protected string $cachePath

cachePath is the base path for cache files

Show inherited protected properties

Inherited Protected Properties

  • $basePath - The base path for the Laravel installation. (defined in Illuminate\Foundation\Application)
  • $hasBeenBootstrapped - Indicates if the application has been bootstrapped before. (defined in Illuminate\Foundation\Application)
  • $booted - Indicates if the application has "booted". (defined in Illuminate\Foundation\Application)
  • $bootingCallbacks - The array of booting callbacks. (defined in Illuminate\Foundation\Application)
  • $bootedCallbacks - The array of booted callbacks. (defined in Illuminate\Foundation\Application)
  • $terminatingCallbacks - The array of terminating callbacks. (defined in Illuminate\Foundation\Application)
  • $serviceProviders - All of the registered service providers. (defined in Illuminate\Foundation\Application)
  • $loadedProviders - The names of the loaded service providers. (defined in Illuminate\Foundation\Application)
  • $deferredServices - The deferred services and their providers. (defined in Illuminate\Foundation\Application)
  • $appPath - The custom application path defined by the developer. (defined in Illuminate\Foundation\Application)
  • $databasePath - The custom database path defined by the developer. (defined in Illuminate\Foundation\Application)
  • $langPath - The custom language file path defined by the developer. (defined in Illuminate\Foundation\Application)
  • $storagePath - The custom storage path defined by the developer. (defined in Illuminate\Foundation\Application)
  • $environmentPath - The custom environment path defined by the developer. (defined in Illuminate\Foundation\Application)
  • $environmentFile - The environment file to load during bootstrapping. (defined in Illuminate\Foundation\Application)
  • $isRunningInConsole - Indicates if the application is running in the console. (defined in Illuminate\Foundation\Application)
  • $namespace - The application namespace. (defined in Illuminate\Foundation\Application)
  • $absoluteCachePathPrefixes - The prefixes of absolute cache paths for use during normalization. (defined in Illuminate\Foundation\Application)
  • $instance - The current globally available container (if any). (defined in Illuminate\Container\Container)
  • $resolved - An array of the types that have been resolved. (defined in Illuminate\Container\Container)
  • $bindings - The container's bindings. (defined in Illuminate\Container\Container)
  • $methodBindings - The container's method bindings. (defined in Illuminate\Container\Container)
  • $instances - The container's shared instances. (defined in Illuminate\Container\Container)
  • $scopedInstances - The container's scoped instances. (defined in Illuminate\Container\Container)
  • $aliases - The registered type aliases. (defined in Illuminate\Container\Container)
  • $abstractAliases - The registered aliases keyed by the abstract name. (defined in Illuminate\Container\Container)
  • $extenders - The extension closures for services. (defined in Illuminate\Container\Container)
  • $tags - All of the registered tags. (defined in Illuminate\Container\Container)
  • $buildStack - The stack of concretions currently being built. (defined in Illuminate\Container\Container)
  • $with - The parameter override stack. (defined in Illuminate\Container\Container)
  • $reboundCallbacks - All of the registered rebound callbacks. (defined in Illuminate\Container\Container)
  • $globalBeforeResolvingCallbacks - All of the global before resolving callbacks. (defined in Illuminate\Container\Container)
  • $globalResolvingCallbacks - All of the global resolving callbacks. (defined in Illuminate\Container\Container)
  • $globalAfterResolvingCallbacks - All of the global after resolving callbacks. (defined in Illuminate\Container\Container)
  • $beforeResolvingCallbacks - All of the before resolving callbacks by class type. (defined in Illuminate\Container\Container)
  • $resolvingCallbacks - All of the resolving callbacks by class type. (defined in Illuminate\Container\Container)
  • $afterResolvingCallbacks - All of the after resolving callbacks by class type. (defined in Illuminate\Container\Container)
  • $macros - The registered string macros. (defined in Illuminate\Foundation\Application)

Public Methods

public after()

public after(Closure|string $callback): void

after logic is called after the router finishes.

public before()

public before(Closure|string $callback): void

before logic is called before the router runs.

public cachePath()

public cachePath(string $path = ''): string

cachePath return path for cache files

public error()

public error(Closure $callback): void

error registers an application error handler.

public extendInstance()

public extendInstance($abstract, $callback): void

extendInstance is useful for extending singletons regardless of their execution

public fatal()

public fatal($callback): void

public getCachedClassesPath()

public getCachedClassesPath(): string

Get the path to the cached packages.php file.

public getCachedCompilePath()

public getCachedCompilePath(): string

Get the path to the cached "compiled.php" file.

public getCachedConfigPath()

public getCachedConfigPath(): string

Get the path to the configuration cache file.

public getCachedPackagesPath()

public getCachedPackagesPath(): string

Get the path to the cached packages.php file.

public getCachedRoutesPath()

public getCachedRoutesPath(): string

Get the path to the routes cache file.

public getCachedServicesPath()

public getCachedServicesPath(): string

Get the path to the cached services.json file.

public getNamespace()

public getNamespace(): string

getNamespace returns the application namespace.

public hasDatabase()

public hasDatabase(): boolean

hasDatabase returns true if a database connection is present.

public hasPublicFolder()

public hasPublicFolder(): void

hasPublicFolder returns true if a public folder exists, initiated by october:mirror

public joinPaths()

public joinPaths(string $basePath, string $path = ''): string

joinPaths together

public pluginsPath()

public pluginsPath(string $path = ''): string

pluginsPath returns path to location of plugins

public publicPath()

public publicPath($path = ''): string

publicPath gets the path to the public / web directory

public registerClassAlias()

public registerClassAlias($alias, $class): void

registerClassAlias registers a new global alias, useful for facades

public registerClassAliases()

public registerClassAliases($aliases): void

registerClassAliases registers multiple global aliases, useful for renamed classes

public registerConfiguredProviders()

public registerConfiguredProviders(): void

registerConfiguredProviders is entirely inherited from the parent, except the October\Rain namespace is included in the partition.

public registerCoreContainerAliases()

public registerCoreContainerAliases(): void

registerCoreContainerAliases in the container.

public runningInBackend()

public runningInBackend(): bool

runningInBackend determines if we are running in the backend area.

public runningInFrontend()

public runningInFrontend(): bool

runningInFrontend determines if we are running in the frontend area.

public setLocale()

public setLocale(string $locale): void

setLocale for the application.

public tempPath()

public tempPath(string $path = ''): string

tempPath returns path for storing temporary files.

public themesPath()

public themesPath(string $path = ''): string

themesPath returns path to location of themes

public useCachePath()

public useCachePath(string $path): $this

useCachePath sets path path for cache files

public usePluginsPath()

public usePluginsPath(string $path): $this

usePluginsPath sets path to location of plugins

public useThemesPath()

public useThemesPath(string $path): $this

useThemesPath sets path to location of themes

Show inherited public methods

Inherited Public Methods

  • __call() - Dynamically handle calls to the class. (defined in Illuminate\Foundation\Application)
  • __callStatic() - Dynamically handle calls to the class. (defined in Illuminate\Foundation\Application)
  • __construct() - Create a new Illuminate application instance. (defined in Illuminate\Foundation\Application)
  • __get() - Dynamically access container services. (defined in Illuminate\Container\Container)
  • __set() - Dynamically set container services. (defined in Illuminate\Container\Container)
  • abort() - Throw an HttpException with the given data. (defined in Illuminate\Foundation\Application)
  • addAbsoluteCachePathPrefix() - Add new prefix to list of absolute path prefixes. (defined in Illuminate\Foundation\Application)
  • addContextualBinding() - Add a contextual binding to the container. (defined in Illuminate\Container\Container)
  • addDeferredServices() - Add an array of services to the application's deferred services. (defined in Illuminate\Foundation\Application)
  • afterBootstrapping() - Register a callback to run after a bootstrapper. (defined in Illuminate\Foundation\Application)
  • afterLoadingEnvironment() - Register a callback to run after loading the environment. (defined in Illuminate\Foundation\Application)
  • afterResolving() - Register a new after resolving callback for all types. (defined in Illuminate\Container\Container)
  • alias() - Alias a type to a different name. (defined in Illuminate\Container\Container)
  • basePath() - Get the base path of the Laravel installation. (defined in Illuminate\Foundation\Application)
  • beforeBootstrapping() - Register a callback to run before a bootstrapper. (defined in Illuminate\Foundation\Application)
  • beforeResolving() - Register a new before resolving callback for all types. (defined in Illuminate\Container\Container)
  • bind() - Register a binding with the container. (defined in Illuminate\Container\Container)
  • bindIf() - Register a binding if it hasn't already been registered. (defined in Illuminate\Container\Container)
  • bindMethod() - Bind a callback to resolve with Container::call. (defined in Illuminate\Container\Container)
  • boot() - Boot the application's service providers. (defined in Illuminate\Foundation\Application)
  • booted() - Register a new "booted" listener. (defined in Illuminate\Foundation\Application)
  • booting() - Register a new boot listener. (defined in Illuminate\Foundation\Application)
  • bootstrapPath() - Get the path to the bootstrap directory. (defined in Illuminate\Foundation\Application)
  • bootstrapWith() - Run the given array of bootstrap classes. (defined in Illuminate\Foundation\Application)
  • bound() - Determine if the given abstract type has been bound. (defined in Illuminate\Foundation\Application)
  • build() - Instantiate a concrete instance of the given type. (defined in Illuminate\Container\Container)
  • call() - Call the given Closure / class@method and inject its dependencies. (defined in Illuminate\Container\Container)
  • callMethodBinding() - Get the method binding for the given method. (defined in Illuminate\Container\Container)
  • configPath() - Get the path to the application configuration files. (defined in Illuminate\Foundation\Application)
  • configurationIsCached() - Determine if the application configuration is cached. (defined in Illuminate\Foundation\Application)
  • currentLocale() - Get the current application locale. (defined in Illuminate\Foundation\Application)
  • databasePath() - Get the path to the database directory. (defined in Illuminate\Foundation\Application)
  • detectEnvironment() - Detect the application's current environment. (defined in Illuminate\Foundation\Application)
  • environment() - Get or check the current application environment. (defined in Illuminate\Foundation\Application)
  • environmentFile() - Get the environment file the application is using. (defined in Illuminate\Foundation\Application)
  • environmentFilePath() - Get the fully qualified path to the environment file. (defined in Illuminate\Foundation\Application)
  • environmentPath() - Get the path to the environment file directory. (defined in Illuminate\Foundation\Application)
  • eventsAreCached() - Determine if the application events are cached. (defined in Illuminate\Foundation\Application)
  • extend() - "Extend" an abstract type in the container. (defined in Illuminate\Container\Container)
  • factory() - Get a closure to resolve the given type from the container. (defined in Illuminate\Container\Container)
  • flush() - Flush the container of all bindings and resolved instances. (defined in Illuminate\Foundation\Application)
  • flushMacros() - Flush the existing macros. (defined in Illuminate\Foundation\Application)
  • forgetExtenders() - Remove all of the extender callbacks for a given type. (defined in Illuminate\Container\Container)
  • forgetInstance() - Remove a resolved instance from the instance cache. (defined in Illuminate\Container\Container)
  • forgetInstances() - Clear all of the instances from the container. (defined in Illuminate\Container\Container)
  • forgetScopedInstances() - Clear all of the scoped instances from the container. (defined in Illuminate\Container\Container)
  • get() - {@inheritdoc}. (defined in Illuminate\Container\Container)
  • getAlias() - Get the alias for an abstract if available. (defined in Illuminate\Container\Container)
  • getBindings() - Get the container's bindings. (defined in Illuminate\Container\Container)
  • getCachedEventsPath() - Get the path to the events cache file. (defined in Illuminate\Foundation\Application)
  • getDeferredServices() - Get the application's deferred services. (defined in Illuminate\Foundation\Application)
  • getFallbackLocale() - Get the current application fallback locale. (defined in Illuminate\Foundation\Application)
  • getInstance() - Get the globally available instance of the container. (defined in Illuminate\Container\Container)
  • getLoadedProviders() - Get the service providers that have been loaded. (defined in Illuminate\Foundation\Application)
  • getLocale() - Get the current application locale. (defined in Illuminate\Foundation\Application)
  • getProvider() - Get the registered service provider instance if it exists. (defined in Illuminate\Foundation\Application)
  • getProviders() - Get the registered service provider instances if any exist. (defined in Illuminate\Foundation\Application)
  • handle() - {@inheritdoc}. (defined in Illuminate\Foundation\Application)
  • has() - {@inheritdoc}. (defined in Illuminate\Container\Container)
  • hasBeenBootstrapped() - Determine if the application has been bootstrapped before. (defined in Illuminate\Foundation\Application)
  • hasDebugModeEnabled() - Determine if the application is running with debug mode enabled. (defined in Illuminate\Foundation\Application)
  • hasMacro() - Checks if macro is registered. (defined in Illuminate\Foundation\Application)
  • hasMethodBinding() - Determine if the container has a method binding. (defined in Illuminate\Container\Container)
  • instance() - Register an existing instance as shared in the container. (defined in Illuminate\Container\Container)
  • isAlias() - Determine if a given string is an alias. (defined in Illuminate\Container\Container)
  • isBooted() - Determine if the application has booted. (defined in Illuminate\Foundation\Application)
  • isDeferredService() - Determine if the given service is a deferred service. (defined in Illuminate\Foundation\Application)
  • isDownForMaintenance() - Determine if the application is currently down for maintenance. (defined in Illuminate\Foundation\Application)
  • isLocal() - Determine if the application is in the local environment. (defined in Illuminate\Foundation\Application)
  • isLocale() - Determine if the application locale is the given locale. (defined in Illuminate\Foundation\Application)
  • isProduction() - Determine if the application is in the production environment. (defined in Illuminate\Foundation\Application)
  • isShared() - Determine if a given type is shared. (defined in Illuminate\Container\Container)
  • langPath() - Get the path to the language files. (defined in Illuminate\Foundation\Application)
  • loadDeferredProvider() - Load the provider for a deferred service. (defined in Illuminate\Foundation\Application)
  • loadDeferredProviders() - Load and boot all of the remaining deferred providers. (defined in Illuminate\Foundation\Application)
  • loadEnvironmentFrom() - Set the environment file to be loaded during bootstrapping. (defined in Illuminate\Foundation\Application)
  • macro() - Register a custom macro. (defined in Illuminate\Foundation\Application)
  • maintenanceMode() - Get an instance of the maintenance mode manager implementation. (defined in Illuminate\Foundation\Application)
  • make() - Resolve the given type from the container. (defined in Illuminate\Foundation\Application)
  • makeWith() - An alias function name for make(). (defined in Illuminate\Container\Container)
  • mixin() - Mix another object into the class. (defined in Illuminate\Foundation\Application)
  • offsetExists() - Determine if a given offset exists. (defined in Illuminate\Container\Container)
  • offsetGet() - Get the value at a given offset. (defined in Illuminate\Container\Container)
  • offsetSet() - Set the value at a given offset. (defined in Illuminate\Container\Container)
  • offsetUnset() - Unset the value at a given offset. (defined in Illuminate\Container\Container)
  • path() - Get the path to the application "app" directory. (defined in Illuminate\Foundation\Application)
  • provideFacades() - Configure the real-time facade namespace. (defined in Illuminate\Foundation\Application)
  • providerIsLoaded() - Determine if the given service provider is loaded. (defined in Illuminate\Foundation\Application)
  • rebinding() - Bind a new callback to an abstract's rebind event. (defined in Illuminate\Container\Container)
  • refresh() - Refresh an instance on the given target and method. (defined in Illuminate\Container\Container)
  • register() - Register a service provider with the application. (defined in Illuminate\Foundation\Application)
  • registerDeferredProvider() - Register a deferred provider and service. (defined in Illuminate\Foundation\Application)
  • resolveProvider() - Resolve a service provider instance from the class name. (defined in Illuminate\Foundation\Application)
  • resolved() - Determine if the given abstract type has been resolved. (defined in Illuminate\Container\Container)
  • resolving() - Register a new resolving callback. (defined in Illuminate\Container\Container)
  • resourcePath() - Get the path to the resources directory. (defined in Illuminate\Foundation\Application)
  • routesAreCached() - Determine if the application routes are cached. (defined in Illuminate\Foundation\Application)
  • runningInConsole() - Determine if the application is running in the console. (defined in Illuminate\Foundation\Application)
  • runningUnitTests() - Determine if the application is running unit tests. (defined in Illuminate\Foundation\Application)
  • scoped() - Register a scoped binding in the container. (defined in Illuminate\Container\Container)
  • scopedIf() - Register a scoped binding if it hasn't already been registered. (defined in Illuminate\Container\Container)
  • setBasePath() - Set the base path for the application. (defined in Illuminate\Foundation\Application)
  • setDeferredServices() - Set the application's deferred services. (defined in Illuminate\Foundation\Application)
  • setFallbackLocale() - Set the current application fallback locale. (defined in Illuminate\Foundation\Application)
  • setInstance() - Set the shared instance of the container. (defined in Illuminate\Container\Container)
  • shouldSkipMiddleware() - Determine if middleware has been disabled for the application. (defined in Illuminate\Foundation\Application)
  • singleton() - Register a shared binding in the container. (defined in Illuminate\Container\Container)
  • singletonIf() - Register a shared binding if it hasn't already been registered. (defined in Illuminate\Container\Container)
  • storagePath() - Get the path to the storage directory. (defined in Illuminate\Foundation\Application)
  • tag() - Assign a set of tags to a given binding. (defined in Illuminate\Container\Container)
  • tagged() - Resolve all of the bindings for a given tag. (defined in Illuminate\Container\Container)
  • terminate() - Terminate the application. (defined in Illuminate\Foundation\Application)
  • terminating() - Register a terminating callback with the application. (defined in Illuminate\Foundation\Application)
  • useAppPath() - Set the application directory. (defined in Illuminate\Foundation\Application)
  • useDatabasePath() - Set the database directory. (defined in Illuminate\Foundation\Application)
  • useEnvironmentPath() - Set the directory for the environment file. (defined in Illuminate\Foundation\Application)
  • useLangPath() - Set the language file directory. (defined in Illuminate\Foundation\Application)
  • useStoragePath() - Set the storage directory. (defined in Illuminate\Foundation\Application)
  • version() - Get the version number of the application. (defined in Illuminate\Foundation\Application)
  • viewPath() - Get the path to the views directory. (defined in Illuminate\Foundation\Application)
  • when() - Define a contextual binding. (defined in Illuminate\Container\Container)
  • wrap() - Wrap the given closure such that its dependencies will be injected when executed. (defined in Illuminate\Container\Container)

Protected Methods

protected bindPathsInContainer()

protected bindPathsInContainer(): void

bindPathsInContainer binds all of the application paths in the container

protected normalizeCachePath()

protected normalizeCachePath(string $key, string $default): string

normalizeCachePath normalizes a relative or absolute path to a cache file.

protected registerBaseServiceProviders()

protected registerBaseServiceProviders(): void

registerBaseServiceProviders registers all of the base service providers

Show inherited protected methods

Inherited Protected Methods

  • bootProvider() - Boot the given service provider. (defined in Illuminate\Foundation\Application)
  • dropStaleInstances() - Drop all of the stale instances and aliases. (defined in Illuminate\Container\Container)
  • findInContextualBindings() - Find the concrete binding for the given abstract in the contextual binding array. (defined in Illuminate\Container\Container)
  • fireAfterResolvingCallbacks() - Fire all of the after resolving callbacks. (defined in Illuminate\Container\Container)
  • fireAppCallbacks() - Call the booting callbacks for the application. (defined in Illuminate\Foundation\Application)
  • fireBeforeCallbackArray() - Fire an array of callbacks with an object. (defined in Illuminate\Container\Container)
  • fireBeforeResolvingCallbacks() - Fire all of the before resolving callbacks. (defined in Illuminate\Container\Container)
  • fireCallbackArray() - Fire an array of callbacks with an object. (defined in Illuminate\Container\Container)
  • fireResolvingCallbacks() - Fire all of the resolving callbacks. (defined in Illuminate\Container\Container)
  • getCallbacksForType() - Get all callbacks for a given type. (defined in Illuminate\Container\Container)
  • getClosure() - Get the Closure to be used when building a type. (defined in Illuminate\Container\Container)
  • getConcrete() - Get the concrete type for a given abstract. (defined in Illuminate\Container\Container)
  • getContextualConcrete() - Get the contextual concrete binding for the given abstract. (defined in Illuminate\Container\Container)
  • getExtenders() - Get the extender callbacks for a given type. (defined in Illuminate\Container\Container)
  • getLastParameterOverride() - Get the last parameter override. (defined in Illuminate\Container\Container)
  • getParameterOverride() - Get a parameter override for a dependency. (defined in Illuminate\Container\Container)
  • getReboundCallbacks() - Get the rebound callbacks for a given type. (defined in Illuminate\Container\Container)
  • hasParameterOverride() - Determine if the given dependency has a parameter override. (defined in Illuminate\Container\Container)
  • isBuildable() - Determine if the given concrete is buildable. (defined in Illuminate\Container\Container)
  • loadDeferredProviderIfNeeded() - Load the deferred provider if the given type is a deferred service and the instance has not been loaded. (defined in Illuminate\Foundation\Application)
  • markAsRegistered() - Mark the given provider as registered. (defined in Illuminate\Foundation\Application)
  • notInstantiable() - Throw an exception that the concrete is not instantiable. (defined in Illuminate\Container\Container)
  • parseBindMethod() - Get the method to be bound in class@method format. (defined in Illuminate\Container\Container)
  • rebound() - Fire the "rebound" callbacks for the given abstract type. (defined in Illuminate\Container\Container)
  • registerBaseBindings() - Register the basic bindings into the container. (defined in Illuminate\Foundation\Application)
  • removeAbstractAlias() - Remove an alias from the contextual binding alias cache. (defined in Illuminate\Container\Container)
  • resolve() - Resolve the given type from the container. (defined in Illuminate\Foundation\Application)
  • resolveClass() - Resolve a class based dependency from the container. (defined in Illuminate\Container\Container)
  • resolveDependencies() - Resolve all of the dependencies from the ReflectionParameters. (defined in Illuminate\Container\Container)
  • resolvePrimitive() - Resolve a non-class hinted primitive dependency. (defined in Illuminate\Container\Container)
  • resolveVariadicClass() - Resolve a class based variadic dependency from the container. (defined in Illuminate\Container\Container)
  • unresolvablePrimitive() - Throw an exception for an unresolvable primitive. (defined in Illuminate\Container\Container)