class Artisan extends Facade

Properties

static protected Container|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|null
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
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|null $name = null)

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 Container|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|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 Kernel
addCommandPaths(array $paths)

No description

static Kernel
addCommandRoutePaths(array $paths)

No description

static Kernel
addCommands(array $commands)

No description

static array
all()

No description

static void
bootstrap()

No description

static void
static int
call(string $command, array $parameters = '[]', OutputInterface|null $outputBuffer = 'null')

No description

static ClosureCommand
command(string $signature, Closure $callback)

No description

static void
commands()

No description

static CarbonImmutable|null
commandStartedAt()

No description

static Command|null
findCommand(string $name)

No description

static Application
getArtisan()

No description

static int
handle(InputInterface $input, OutputInterface|null $output = 'null')

No description

static void
load(array|string $paths)

No description

static string
output()

No description

static PendingDispatch
queue(string $command, array $parameters = '[]')

No description

static void
registerCommand(Command $command)

No description

static Schedule
resolveConsoleSchedule()

No description

static int
run(InputInterface|null $input = 'null', OutputInterface|null $output = 'null')

No description

static void
schedule(Schedule $schedule)

No description

static void
setArtisan(Application|null $artisan)

No description

static void
terminate(InputInterface $input, int $status)

No description

static void
whenCommandLifecycleIsLongerThan(DateTimeInterface|int|float $threshold, callable $handler)

No description

Details

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

Run a Closure when the facade has been resolved.

Boot-only. The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 81
static MockInterface|null spy()

Convert the facade into a Mockery spy.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface|null

in Facade at line 99
static MockInterface partialMock()

Initiate a partial mock on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 115
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

in Facade at line 131
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 145
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 157
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 167
static protected bool isMock()

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

Return Value

bool

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

Get the mockable class for the bound instance.

Return Value

string|null

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

Hotswap the underlying instance behind the facade.

Tests only. Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

Return Value

void

in Facade at line 206
static bool isFake()

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

Return Value

bool

in Facade at line 217
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 41
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

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

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 256
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Boot or tests only. Clears a worker-wide facade cache entry; concurrent coroutines may still hold the previous resolved instance.

Parameters

string|null $name

Return Value

void

in Facade at line 267
static void clearResolvedInstances()

Clear all of the resolved instances.

Boot or tests only. Clears the worker-wide facade cache; concurrent coroutines may still hold previously resolved instances.

Return Value

void

in Facade at line 275
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 335
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

in Facade at line 346
static void setFacadeApplication(Container|null $app)

Set the application instance.

Boot or tests only. Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

Container|null $app

Return Value

void

in Facade at line 356
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 36
static Kernel addCommandPaths(array $paths)

No description

Parameters

array $paths

Return Value

Kernel

at line 36
static Kernel addCommandRoutePaths(array $paths)

No description

Parameters

array $paths

Return Value

Kernel

at line 36
static Kernel addCommands(array $commands)

No description

Parameters

array $commands

Return Value

Kernel

at line 36
static array all()

No description

Return Value

array

at line 36
static void bootstrap()

No description

Return Value

void

at line 36
static void bootstrapWithoutBootingProviders()

No description

Return Value

void

at line 36
static int call(string $command, array $parameters = '[]', OutputInterface|null $outputBuffer = 'null')

No description

Parameters

string $command
array $parameters
OutputInterface|null $outputBuffer

Return Value

int

at line 36
static ClosureCommand command(string $signature, Closure $callback)

No description

Parameters

string $signature
Closure $callback

Return Value

ClosureCommand

at line 36
static void commands()

No description

Return Value

void

at line 36
static CarbonImmutable|null commandStartedAt()

No description

Return Value

CarbonImmutable|null

at line 36
static Command|null findCommand(string $name)

No description

Parameters

string $name

Return Value

Command|null

at line 36
static Application getArtisan()

No description

Return Value

Application

at line 36
static int handle(InputInterface $input, OutputInterface|null $output = 'null')

No description

Parameters

InputInterface $input
OutputInterface|null $output

Return Value

int

at line 36
static void load(array|string $paths)

No description

Parameters

array|string $paths

Return Value

void

at line 36
static string output()

No description

Return Value

string

at line 36
static PendingDispatch queue(string $command, array $parameters = '[]')

No description

Parameters

string $command
array $parameters

Return Value

PendingDispatch

at line 36
static void registerCommand(Command $command)

No description

Parameters

Command $command

Return Value

void

at line 36
static Schedule resolveConsoleSchedule()

No description

Return Value

Schedule

at line 36
static int run(InputInterface|null $input = 'null', OutputInterface|null $output = 'null')

No description

Parameters

InputInterface|null $input
OutputInterface|null $output

Return Value

int

at line 36
static void schedule(Schedule $schedule)

No description

Parameters

Schedule $schedule

Return Value

void

at line 36
static void setArtisan(Application|null $artisan)

No description

Parameters

Application|null $artisan

Return Value

void

at line 36
static void terminate(InputInterface $input, int $status)

No description

Parameters

InputInterface $input
int $status

Return Value

void

at line 36
static void whenCommandLifecycleIsLongerThan(DateTimeInterface|int|float $threshold, callable $handler)

No description

Parameters

DateTimeInterface|int|float $threshold
callable $handler

Return Value

void