Application

interface Application implements Container (View source)

Methods

bool

bound(string $abstract)

Determine if the given abstract type has been bound.

from Container

void

alias(string $abstract, string $alias)

Alias a type to a different name.

from Container

void

tag(array|string $abstracts, array|mixed $tags)

Assign a set of tags to a given binding.

from Container

iterable

tagged(string $tag)

Resolve all of the bindings for a given tag.

from Container

void

bind(string $abstract, Closure|string|null $concrete = null, bool $shared = false)

from Container

void

bindIf(string $abstract, Closure|string|null $concrete = null, bool $shared = false)

from Container

void

singleton(string $abstract, Closure|string|null $concrete = null)

from Container

void

extend(string $abstract, Closure $closure)

"Extend" an abstract type in the container.

from Container

mixed

instance(string $abstract, mixed $instance)

from Container

void

addContextualBinding(string $concrete, string $abstract, Closure|string $implementation)

Add a contextual binding to the container.

from Container

ContextualBindingBuilder

when(string|array $concrete)

Define a contextual binding.

from Container

Closure

factory(string $abstract)

Get a closure to resolve the given type from the container.

from Container

void

flush()

Flush the container of all bindings and resolved instances.

from Container

mixed

make(string $abstract, array $parameters = [])

Resolve the given type from the container.

from Container

mixed

call(callable|string $callback, array $parameters = [], string|null $defaultMethod = null)

Call the given Closure / class@method and inject its dependencies.

from Container

bool

resolved(string $abstract)

Determine if the given abstract type has been resolved.

from Container

void

resolving(Closure|string $abstract, Closure $callback = null)

from Container

void

afterResolving(Closure|string $abstract, Closure $callback = null)

from Container

string

version()

Get the version number of the application.

string

basePath()

Get the base path of the Laravel installation.

string

bootstrapPath(string $path = '')

Get the path to the bootstrap directory.

string

configPath(string $path = '')

Get the path to the application configuration files.

string

databasePath(string $path = '')

Get the path to the database directory.

string

environmentPath()

Get the path to the environment file directory.

string

resourcePath(string $path = '')

Get the path to the resources directory.

string

storagePath()

Get the path to the storage directory.

string|bool

environment(string|array ...$environments)

Get or check the current application environment.

bool

runningInConsole()

Determine if the application is running in the console.

bool

runningUnitTests()

Determine if the application is running unit tests.

bool

isDownForMaintenance()

Determine if the application is currently down for maintenance.

void

registerConfiguredProviders()

ServiceProvider

void

registerDeferredProvider(string $provider, string|null $service = null)

ServiceProvider

resolveProvider(string $provider)

Resolve a service provider instance from the class name.

void

boot()

Boot the application's service providers.

void

booting(callable $callback)

void

booted(callable $callback)

void

bootstrapWith(array $bootstrappers)

Run the given array of bootstrap classes.

bool

configurationIsCached()

Determine if the application configuration is cached.

string

detectEnvironment(Closure $callback)

Detect the application's current environment.

string

environmentFile()

Get the environment file the application is using.

string

environmentFilePath()

Get the fully qualified path to the environment file.

string

getCachedConfigPath()

Get the path to the configuration cache file.

string

getCachedServicesPath()

Get the path to the cached services.php file.

string

getCachedPackagesPath()

Get the path to the cached packages.php file.

string

getCachedRoutesPath()

Get the path to the routes cache file.

string

getLocale()

Get the current application locale.

string

getNamespace()

Get the application namespace.

array

getProviders(ServiceProvider|string $provider)

Get the registered service provider instances if any exist.

bool

hasBeenBootstrapped()

Determine if the application has been bootstrapped before.

void

loadDeferredProviders()

Load and boot all of the remaining deferred providers.

$this

loadEnvironmentFrom(string $file)

Set the environment file to be loaded during bootstrapping.

bool

routesAreCached()

Determine if the application routes are cached.

void

setLocale(string $locale)

Set the current application locale.

bool

shouldSkipMiddleware()

Determine if middleware has been disabled for the application.

void

terminate()

Terminate the application.

Details

bool bound(string $abstract)

Determine if the given abstract type has been bound.

Parameters

string

$abstract

Return Value

bool

void alias(string $abstract, string $alias)

Alias a type to a different name.

Parameters

string	$abstract
string	$alias

Return Value

void

Exceptions

LogicException

void tag(array|string $abstracts, array|mixed $tags)

Assign a set of tags to a given binding.

Parameters

array\|string	$abstracts
array\|mixed	$tags

Return Value

void

iterable tagged(string $tag)

Resolve all of the bindings for a given tag.

Parameters

string

$tag

Return Value

iterable

void bind(string $abstract, Closure|string|null $concrete = null, bool $shared = false)

Parameters

string	$abstract
Closure\|string\|null	$concrete
bool	$shared

Return Value

void

void bindIf(string $abstract, Closure|string|null $concrete = null, bool $shared = false)

Parameters

string	$abstract
Closure\|string\|null	$concrete
bool	$shared

Return Value

void

void singleton(string $abstract, Closure|string|null $concrete = null)

Parameters

string	$abstract
Closure\|string\|null	$concrete

Return Value

void

void extend(string $abstract, Closure $closure)

"Extend" an abstract type in the container.

Parameters

string	$abstract
Closure	$closure

Return Value

void

Exceptions

InvalidArgumentException

mixed instance(string $abstract, mixed $instance)

Parameters

string	$abstract
mixed	$instance

Return Value

mixed

void addContextualBinding(string $concrete, string $abstract, Closure|string $implementation)

Add a contextual binding to the container.

Parameters

string	$concrete
string	$abstract
Closure\|string	$implementation

Return Value

void

ContextualBindingBuilder when(string|array $concrete)

Define a contextual binding.

Parameters

string|array

$concrete

Return Value

ContextualBindingBuilder

Closure factory(string $abstract)

Get a closure to resolve the given type from the container.

Parameters

string

$abstract

Return Value

Closure

void flush()

Flush the container of all bindings and resolved instances.

Return Value

void

mixed make(string $abstract, array $parameters = [])

Resolve the given type from the container.

Parameters

string	$abstract
array	$parameters

Return Value

mixed

Exceptions

BindingResolutionException

mixed call(callable|string $callback, array $parameters = [], string|null $defaultMethod = null)

Call the given Closure / class@method and inject its dependencies.

Parameters

callable\|string	$callback
array	$parameters
string\|null	$defaultMethod

Return Value

mixed

bool resolved(string $abstract)

Determine if the given abstract type has been resolved.

Parameters

string

$abstract

Return Value

bool

void resolving(Closure|string $abstract, Closure $callback = null)

Parameters

Closure\|string	$abstract
Closure	$callback

Return Value

void

void afterResolving(Closure|string $abstract, Closure $callback = null)

Parameters

Closure\|string	$abstract
Closure	$callback

Return Value

void

string version()

Get the version number of the application.

Return Value

string

string basePath()

Get the base path of the Laravel installation.

Return Value

string

string bootstrapPath(string $path = '')

Get the path to the bootstrap directory.

Parameters

string

$path

Optionally, a path to append to the bootstrap path

Return Value

string

string configPath(string $path = '')

Get the path to the application configuration files.

Parameters

string

$path

Optionally, a path to append to the config path

Return Value

string

string databasePath(string $path = '')

Get the path to the database directory.

Parameters

string

$path

Optionally, a path to append to the database path

Return Value

string

string environmentPath()

Get the path to the environment file directory.

Return Value

string

string resourcePath(string $path = '')

Get the path to the resources directory.

Parameters

string

$path

Return Value

string

string storagePath()

Get the path to the storage directory.

Return Value

string

string|bool environment(string|array ...$environments)

Get or check the current application environment.

Parameters

string|array

...$environments

Return Value

string|bool

bool runningInConsole()

Determine if the application is running in the console.

Return Value

bool

bool runningUnitTests()

Determine if the application is running unit tests.

Return Value

bool

bool isDownForMaintenance()

Determine if the application is currently down for maintenance.

Return Value

bool

void registerConfiguredProviders()

Return Value

void

ServiceProvider register(ServiceProvider|string $provider, bool $force = false)

Parameters

ServiceProvider\|string	$provider
bool	$force

Return Value

ServiceProvider

void registerDeferredProvider(string $provider, string|null $service = null)

Parameters

string	$provider
string\|null	$service

Return Value

void

ServiceProvider resolveProvider(string $provider)

Resolve a service provider instance from the class name.

Parameters

string

$provider

Return Value

ServiceProvider

void boot()

Boot the application's service providers.

Return Value

void

void booting(callable $callback)

Parameters

callable

$callback

Return Value

void

void booted(callable $callback)

Parameters

callable

$callback

Return Value

void

void bootstrapWith(array $bootstrappers)

Run the given array of bootstrap classes.

Parameters

array

$bootstrappers

Return Value

void

bool configurationIsCached()

Determine if the application configuration is cached.

Return Value

bool

string detectEnvironment(Closure $callback)

Detect the application's current environment.

Parameters

Closure

$callback

Return Value

string

string environmentFile()

Get the environment file the application is using.

Return Value

string

string environmentFilePath()

Get the fully qualified path to the environment file.

Return Value

string

string getCachedConfigPath()

Get the path to the configuration cache file.

Return Value

string

string getCachedServicesPath()

Get the path to the cached services.php file.

Return Value

string

string getCachedPackagesPath()

Get the path to the cached packages.php file.

Return Value

string

string getCachedRoutesPath()

Get the path to the routes cache file.

Return Value

string

string getLocale()

Get the current application locale.

Return Value

string

string getNamespace()

Get the application namespace.

Return Value

string

Exceptions

RuntimeException

array getProviders(ServiceProvider|string $provider)

Get the registered service provider instances if any exist.

Parameters

ServiceProvider|string

$provider

Return Value

array

bool hasBeenBootstrapped()

Determine if the application has been bootstrapped before.

Return Value

bool

void loadDeferredProviders()

Load and boot all of the remaining deferred providers.

Return Value

void

$this loadEnvironmentFrom(string $file)

Set the environment file to be loaded during bootstrapping.

Parameters

string

$file

Return Value

$this

bool routesAreCached()

Determine if the application routes are cached.

Return Value

bool

void setLocale(string $locale)

Set the current application locale.

Parameters

string

$locale

Return Value

void

bool shouldSkipMiddleware()

Determine if middleware has been disabled for the application.

Return Value

bool

void terminate()

Terminate the application.

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.8/Illuminate/Contracts/Foundation/Application.html