1. class
  2. Illuminate
  3. \
  4. Support
  5. \
  6. Facades
  7. \
  8. App

App

class App extends Facade (View source)

Properties

static protected Application|null $app

The application instance being facaded.

 from  Facade
static protected array $resolvedInstance

The resolved object instances.

 from  Facade
static protected bool $cached

Indicates if the resolved instance should be cached.

 from  Facade

Methods

static void
resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from  Facade
static MockInterface
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static Expectation
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static Expectation
expects()

Initiate a mock expectation on the facade.

from  Facade
static MockInterface
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static MockInterface
createMock()

Create a fresh mock instance for the given class.

from  Facade
static bool
isMock()

Determines whether a mock is set as the instance of the facade.

from  Facade
static string|null
getMockableClass()

Get the mockable class for the bound instance.

from  Facade
static void
swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from  Facade
static bool
isFake()

Determines whether a "fake" has been set as the facade instance.

from  Facade
static mixed
getFacadeRoot()

Get the root object behind the facade.

from  Facade
static string
getFacadeAccessor()

Get the registered name of the component.

static mixed
resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from  Facade
static void
clearResolvedInstance(string $name)

Clear a resolved facade instance.

from  Facade
static void
clearResolvedInstances()

Clear all of the resolved instances.

from  Facade
static Collection
defaultAliases()

Get the application default aliases.

from  Facade
static Application|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Application|null $app)

Set the application instance.

from  Facade
static mixed
__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from  Facade
static string
version()

No description

static void
bootstrapWith(string[] $bootstrappers)

No description

static void
afterLoadingEnvironment(Closure $callback)

No description

static void
beforeBootstrapping(string $bootstrapper, Closure $callback)

No description

static void
afterBootstrapping(string $bootstrapper, Closure $callback)

No description

static bool
hasBeenBootstrapped()

No description

static Application
setBasePath(string $basePath)

No description

static string
path(string $path = '')

No description

static Application
useAppPath(string $path)

No description

static string
basePath(string $path = '')

No description

static string
bootstrapPath(string $path = '')

No description

static Application
useBootstrapPath(string $path)

No description

static string
configPath(string $path = '')

No description

static Application
useConfigPath(string $path)

No description

static string
databasePath(string $path = '')

No description

static Application
useDatabasePath(string $path)

No description

static string
langPath(string $path = '')

No description

static Application
useLangPath(string $path)

No description

static string
publicPath(string $path = '')

No description

static Application
usePublicPath(string $path)

No description

static string
storagePath(string $path = '')

No description

static Application
useStoragePath(string $path)

No description

static string
resourcePath(string $path = '')

No description

static string
viewPath(string $path = '')

No description

static string
joinPaths(string $basePath, string $path = '')

No description

static string
environmentPath()

No description

static Application
useEnvironmentPath(string $path)

No description

static Application
loadEnvironmentFrom(string $file)

No description

static string
environmentFile()

No description

static string
environmentFilePath()

No description

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

No description

static bool
isLocal()

No description

static bool
isProduction()

No description

static string
detectEnvironment(Closure $callback)

No description

static bool
runningInConsole()

No description

static bool
runningConsoleCommand(string|array $commands)

No description

static bool
runningUnitTests()

No description

static bool
hasDebugModeEnabled()

No description

static void
registerConfiguredProviders()

No description

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

No description

static ServiceProvider|null
getProvider(ServiceProvider|string $provider)

No description

static array
getProviders(ServiceProvider|string $provider)

No description

static ServiceProvider
resolveProvider(string $provider)

No description

static void
loadDeferredProviders()

No description

static void
loadDeferredProvider(string $service)

No description

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

No description

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

No description

static bool
bound(string $abstract)

No description

static bool
isBooted()

No description

static void
boot()

No description

static void
booting(callable $callback)

No description

static void
booted(callable $callback)

No description

static Response
handle(Request $request, int $type = 1, bool $catch = true)

No description

static bool
shouldSkipMiddleware()

No description

static string
getCachedServicesPath()

No description

static string
getCachedPackagesPath()

No description

static bool
configurationIsCached()

No description

static string
getCachedConfigPath()

No description

static bool
routesAreCached()

No description

static string
getCachedRoutesPath()

No description

static bool
eventsAreCached()

No description

static string
getCachedEventsPath()

No description

static Application
addAbsoluteCachePathPrefix(string $prefix)

No description

static MaintenanceMode
maintenanceMode()

No description

static bool
isDownForMaintenance()

No description

static never
abort(int $code, string $message = '', array $headers = [])

No description

static Application
terminating(callable|string $callback)

No description

static void
terminate()

No description

static array
getLoadedProviders()

No description

static bool
providerIsLoaded(string $provider)

No description

static array
getDeferredServices()

No description

static void
setDeferredServices(array $services)

No description

static void
addDeferredServices(array $services)

No description

static bool
isDeferredService(string $service)

No description

static void
provideFacades(string $namespace)

No description

static string
getLocale()

No description

static string
currentLocale()

No description

static string
getFallbackLocale()

No description

static void
setLocale(string $locale)

No description

static void
setFallbackLocale(string $fallbackLocale)

No description

static bool
isLocale(string $locale)

No description

static void
registerCoreContainerAliases()

No description

static void
flush()

No description

static string
getNamespace()

No description

static ContextualBindingBuilder
when(array|string $concrete)

No description

static bool
has(string $id)

No description

static bool
isShared(string $abstract)

No description

static bool
isAlias(string $name)

No description

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

No description

static bool
hasMethodBinding(string $method)

No description

static void
bindMethod(array|string $method, Closure $callback)

No description

static mixed
callMethodBinding(string $method, mixed $instance)

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

static void
extend(string $abstract, Closure $closure)

No description

static mixed
instance(string $abstract, mixed $instance)

No description

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

No description

static iterable
tagged(string $tag)

No description

static void
alias(string $abstract, string $alias)

No description

static mixed
rebinding(string $abstract, Closure $callback)

No description

static mixed
refresh(string $abstract, mixed $target, string $method)

No description

static Closure
wrap(Closure $callback, array $parameters = [])

No description

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

No description

static Closure
factory(string $abstract)

No description

static mixed
makeWith(string|callable $abstract, array $parameters = [])

No description

static mixed
get(string $id)

No description

static mixed
build(Closure|string $concrete)

No description

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

No description

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

No description

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

No description

static array
getBindings()

No description

static string
getAlias(string $abstract)

No description

static void
forgetExtenders(string $abstract)

No description

static void
forgetInstance(string $abstract)

No description

static void
forgetInstances()

No description

static void
forgetScopedInstances()

No description

static Application
getInstance()

No description

static Application
setInstance(Container|null $container = null)

No description

static void
macro(string $name, object|callable $macro)

No description

static void
mixin(object $mixin, bool $replace = true)

No description

static bool
hasMacro(string $name)

No description

static void
flushMacros()

No description

Details

in Facade at line 45
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

in Facade at line 63
static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

in Facade at line 79
static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

in Facade at line 95
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 111
static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 127
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 141
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 153
static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

in Facade at line 166
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 179
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

in Facade at line 193
static protected bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

in Facade at line 206
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 142
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 229
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 250
static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

in Facade at line 260
static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

in Facade at line 270
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 322
static Application|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application|null

in Facade at line 333
static void setFacadeApplication(Application|null $app)

Set the application instance.

Parameters

Application|null $app

Return Value

void

in Facade at line 347
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

at line 135
static string version()

No description

Return Value

string

at line 135
static void bootstrapWith(string[] $bootstrappers)

No description

Parameters

string[] $bootstrappers

Return Value

void

at line 135
static void afterLoadingEnvironment(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

at line 135
static void beforeBootstrapping(string $bootstrapper, Closure $callback)

No description

Parameters

string $bootstrapper
Closure $callback

Return Value

void

at line 135
static void afterBootstrapping(string $bootstrapper, Closure $callback)

No description

Parameters

string $bootstrapper
Closure $callback

Return Value

void

at line 135
static bool hasBeenBootstrapped()

No description

Return Value

bool

at line 135
static Application setBasePath(string $basePath)

No description

Parameters

string $basePath

Return Value

Application

at line 135
static string path(string $path = '')

No description

Parameters

string $path

Return Value

string

at line 135
static Application useAppPath(string $path)

No description

Parameters

string $path

Return Value

Application

at line 135
static string basePath(string $path = '')

No description

Parameters

string $path

Return Value

string

at line 135
static string bootstrapPath(string $path = '')

No description

Parameters

string $path

Return Value

string

at line 135
static Application useBootstrapPath(string $path)

No description

Parameters

string $path

Return Value

Application

at line 135
static string configPath(string $path = '')

No description

Parameters

string $path

Return Value

string

at line 135
static Application useConfigPath(string $path)

No description

Parameters

string $path

Return Value

Application

at line 135
static string databasePath(string $path = '')

No description

Parameters

string $path

Return Value

string

at line 135
static Application useDatabasePath(string $path)

No description

Parameters

string $path

Return Value

Application

at line 135
static string langPath(string $path = '')

No description

Parameters

string $path

Return Value

string

at line 135
static Application useLangPath(string $path)

No description

Parameters

string $path

Return Value

Application

at line 135
static string publicPath(string $path = '')

No description

Parameters

string $path

Return Value

string

at line 135
static Application usePublicPath(string $path)

No description

Parameters

string $path

Return Value

Application

at line 135
static string storagePath(string $path = '')

No description

Parameters

string $path

Return Value

string

at line 135
static Application useStoragePath(string $path)

No description

Parameters

string $path

Return Value

Application

at line 135
static string resourcePath(string $path = '')

No description

Parameters

string $path

Return Value

string

at line 135
static string viewPath(string $path = '')

No description

Parameters

string $path

Return Value

string

at line 135
static string joinPaths(string $basePath, string $path = '')

No description

Parameters

string $basePath
string $path

Return Value

string

at line 135
static string environmentPath()

No description

Return Value

string

at line 135
static Application useEnvironmentPath(string $path)

No description

Parameters

string $path

Return Value

Application

at line 135
static Application loadEnvironmentFrom(string $file)

No description

Parameters

string $file

Return Value

Application

at line 135
static string environmentFile()

No description

Return Value

string

at line 135
static string environmentFilePath()

No description

Return Value

string

at line 135
static string|bool environment(string|array $environments)

No description

Parameters

string|array $environments

Return Value

string|bool

at line 135
static bool isLocal()

No description

Return Value

bool

at line 135
static bool isProduction()

No description

Return Value

bool

at line 135
static string detectEnvironment(Closure $callback)

No description

Parameters

Closure $callback

Return Value

string

at line 135
static bool runningInConsole()

No description

Return Value

bool

at line 135
static bool runningConsoleCommand(string|array $commands)

No description

Parameters

string|array $commands

Return Value

bool

at line 135
static bool runningUnitTests()

No description

Return Value

bool

at line 135
static bool hasDebugModeEnabled()

No description

Return Value

bool

at line 135
static void registerConfiguredProviders()

No description

Return Value

void

at line 135
static ServiceProvider register(ServiceProvider|string $provider, bool $force = false)

No description

Parameters

ServiceProvider|string $provider
bool $force

Return Value

ServiceProvider

at line 135
static ServiceProvider|null getProvider(ServiceProvider|string $provider)

No description

Parameters

ServiceProvider|string $provider

Return Value

ServiceProvider|null

at line 135
static array getProviders(ServiceProvider|string $provider)

No description

Parameters

ServiceProvider|string $provider

Return Value

array

at line 135
static ServiceProvider resolveProvider(string $provider)

No description

Parameters

string $provider

Return Value

ServiceProvider

at line 135
static void loadDeferredProviders()

No description

Return Value

void

at line 135
static void loadDeferredProvider(string $service)

No description

Parameters

string $service

Return Value

void

at line 135
static void registerDeferredProvider(string $provider, string|null $service = null)

No description

Parameters

string $provider
string|null $service

Return Value

void

at line 135
static mixed make(string $abstract, array $parameters = [])

No description

Parameters

string $abstract
array $parameters

Return Value

mixed

at line 135
static bool bound(string $abstract)

No description

Parameters

string $abstract

Return Value

bool

at line 135
static bool isBooted()

No description

Return Value

bool

at line 135
static void boot()

No description

Return Value

void

at line 135
static void booting(callable $callback)

No description

Parameters

callable $callback

Return Value

void

at line 135
static void booted(callable $callback)

No description

Parameters

callable $callback

Return Value

void

at line 135
static Response handle(Request $request, int $type = 1, bool $catch = true)

No description

Parameters

Request $request
int $type
bool $catch

Return Value

Response

at line 135
static bool shouldSkipMiddleware()

No description

Return Value

bool

at line 135
static string getCachedServicesPath()

No description

Return Value

string

at line 135
static string getCachedPackagesPath()

No description

Return Value

string

at line 135
static bool configurationIsCached()

No description

Return Value

bool

at line 135
static string getCachedConfigPath()

No description

Return Value

string

at line 135
static bool routesAreCached()

No description

Return Value

bool

at line 135
static string getCachedRoutesPath()

No description

Return Value

string

at line 135
static bool eventsAreCached()

No description

Return Value

bool

at line 135
static string getCachedEventsPath()

No description

Return Value

string

at line 135
static Application addAbsoluteCachePathPrefix(string $prefix)

No description

Parameters

string $prefix

Return Value

Application

at line 135
static MaintenanceMode maintenanceMode()

No description

Return Value

MaintenanceMode

at line 135
static bool isDownForMaintenance()

No description

Return Value

bool

at line 135
static never abort(int $code, string $message = '', array $headers = [])

No description

Parameters

int $code
string $message
array $headers

Return Value

never

at line 135
static Application terminating(callable|string $callback)

No description

Parameters

callable|string $callback

Return Value

Application

at line 135
static void terminate()

No description

Return Value

void

at line 135
static array getLoadedProviders()

No description

Return Value

array

at line 135
static bool providerIsLoaded(string $provider)

No description

Parameters

string $provider

Return Value

bool

at line 135
static array getDeferredServices()

No description

Return Value

array

at line 135
static void setDeferredServices(array $services)

No description

Parameters

array $services

Return Value

void

at line 135
static void addDeferredServices(array $services)

No description

Parameters

array $services

Return Value

void

at line 135
static bool isDeferredService(string $service)

No description

Parameters

string $service

Return Value

bool

at line 135
static void provideFacades(string $namespace)

No description

Parameters

string $namespace

Return Value

void

at line 135
static string getLocale()

No description

Return Value

string

at line 135
static string currentLocale()

No description

Return Value

string

at line 135
static string getFallbackLocale()

No description

Return Value

string

at line 135
static void setLocale(string $locale)

No description

Parameters

string $locale

Return Value

void

at line 135
static void setFallbackLocale(string $fallbackLocale)

No description

Parameters

string $fallbackLocale

Return Value

void

at line 135
static bool isLocale(string $locale)

No description

Parameters

string $locale

Return Value

bool

at line 135
static void registerCoreContainerAliases()

No description

Return Value

void

at line 135
static void flush()

No description

Return Value

void

at line 135
static string getNamespace()

No description

Return Value

string

at line 135
static ContextualBindingBuilder when(array|string $concrete)

No description

Parameters

array|string $concrete

Return Value

ContextualBindingBuilder

at line 135
static bool has(string $id)

No description

Parameters

string $id

Return Value

bool

at line 135
static bool isShared(string $abstract)

No description

Parameters

string $abstract

Return Value

bool

at line 135
static bool isAlias(string $name)

No description

Parameters

string $name

Return Value

bool

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

No description

Parameters

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

Return Value

void

at line 135
static bool hasMethodBinding(string $method)

No description

Parameters

string $method

Return Value

bool

at line 135
static void bindMethod(array|string $method, Closure $callback)

No description

Parameters

array|string $method
Closure $callback

Return Value

void

at line 135
static mixed callMethodBinding(string $method, mixed $instance)

No description

Parameters

string $method
mixed $instance

Return Value

mixed

at line 135
static void addContextualBinding(string $concrete, string $abstract, Closure|string $implementation)

No description

Parameters

string $concrete
string $abstract
Closure|string $implementation

Return Value

void

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

No description

Parameters

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

Return Value

void

at line 135
static void singleton(string $abstract, Closure|string|null $concrete = null)

No description

Parameters

string $abstract
Closure|string|null $concrete

Return Value

void

at line 135
static void singletonIf(string $abstract, Closure|string|null $concrete = null)

No description

Parameters

string $abstract
Closure|string|null $concrete

Return Value

void

at line 135
static void scoped(string $abstract, Closure|string|null $concrete = null)

No description

Parameters

string $abstract
Closure|string|null $concrete

Return Value

void

at line 135
static void scopedIf(string $abstract, Closure|string|null $concrete = null)

No description

Parameters

string $abstract
Closure|string|null $concrete

Return Value

void

at line 135
static void extend(string $abstract, Closure $closure)

No description

Parameters

string $abstract
Closure $closure

Return Value

void

at line 135
static mixed instance(string $abstract, mixed $instance)

No description

Parameters

string $abstract
mixed $instance

Return Value

mixed

at line 135
static void tag(array|string $abstracts, array|mixed $tags)

No description

Parameters

array|string $abstracts
array|mixed $tags

Return Value

void

at line 135
static iterable tagged(string $tag)

No description

Parameters

string $tag

Return Value

iterable

at line 135
static void alias(string $abstract, string $alias)

No description

Parameters

string $abstract
string $alias

Return Value

void

at line 135
static mixed rebinding(string $abstract, Closure $callback)

No description

Parameters

string $abstract
Closure $callback

Return Value

mixed

at line 135
static mixed refresh(string $abstract, mixed $target, string $method)

No description

Parameters

string $abstract
mixed $target
string $method

Return Value

mixed

at line 135
static Closure wrap(Closure $callback, array $parameters = [])

No description

Parameters

Closure $callback
array $parameters

Return Value

Closure

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

No description

Parameters

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

Return Value

mixed

at line 135
static Closure factory(string $abstract)

No description

Parameters

string $abstract

Return Value

Closure

at line 135
static mixed makeWith(string|callable $abstract, array $parameters = [])

No description

Parameters

string|callable $abstract
array $parameters

Return Value

mixed

at line 135
static mixed get(string $id)

No description

Parameters

string $id

Return Value

mixed

at line 135
static mixed build(Closure|string $concrete)

No description

Parameters

Closure|string $concrete

Return Value

mixed

at line 135
static void beforeResolving(Closure|string $abstract, Closure|null $callback = null)

No description

Parameters

Closure|string $abstract
Closure|null $callback

Return Value

void

at line 135
static void resolving(Closure|string $abstract, Closure|null $callback = null)

No description

Parameters

Closure|string $abstract
Closure|null $callback

Return Value

void

at line 135
static void afterResolving(Closure|string $abstract, Closure|null $callback = null)

No description

Parameters

Closure|string $abstract
Closure|null $callback

Return Value

void

at line 135
static array getBindings()

No description

Return Value

array

at line 135
static string getAlias(string $abstract)

No description

Parameters

string $abstract

Return Value

string

at line 135
static void forgetExtenders(string $abstract)

No description

Parameters

string $abstract

Return Value

void

at line 135
static void forgetInstance(string $abstract)

No description

Parameters

string $abstract

Return Value

void

at line 135
static void forgetInstances()

No description

Return Value

void

at line 135
static void forgetScopedInstances()

No description

Return Value

void

at line 135
static Application getInstance()

No description

Return Value

Application

at line 135
static Application setInstance(Container|null $container = null)

No description

Parameters

Container|null $container

Return Value

Application

at line 135
static void macro(string $name, object|callable $macro)

No description

Parameters

string $name
object|callable $macro

Return Value

void

at line 135
static void mixin(object $mixin, bool $replace = true)

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 135
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 135
static void flushMacros()

No description

Return Value

void