class Application extends Application implements Application (View source)

Properties

protected Container $laravel

The Laravel application instance.

protected Dispatcher $events

The event dispatcher instance.

protected BufferedOutput $lastOutput

The output from the previous command.

static protected array $bootstrappers

The console application bootstrappers.

protected array $commandMap

A map of command names to classes.

Methods

void
__construct(Container $laravel, Dispatcher $events, string $version)

Create a new Artisan console application.

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

{@inheritdoc}

static string
phpBinary()

Determine the proper PHP executable.

static string
artisanBinary()

Determine the proper Artisan executable.

static string
formatCommandString(string $string)

Format the given command as a fully-qualified executable command.

static void
starting(Closure $callback)

Register a console "starting" bootstrapper.

void
bootstrap()

Bootstrap the console application.

static void
forgetBootstrappers()

Clear the console application bootstrappers.

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

Run an Artisan console command by name.

array
parseCommand(string $command, array $parameters)

Parse the incoming Artisan command and its input.

string
output()

Get the output for the last run command.

Command
add(Command $command)

Add a command to the console.

Command
addToParent(Command $command)

Add the command to the parent instance.

Command|null
resolve(Command|string $command)

Add a command, resolving through the application.

$this
resolveCommands(array|mixed $commands)

Resolve an array of commands through the application.

$this
setContainerCommandLoader()

Set the container command loader for lazy resolution.

InputDefinition
getDefaultInputDefinition()

Get the default input definition for the application.

InputOption
getEnvironmentOption()

Get the global environment option for the definition.

getLaravel()

Get the Laravel application instance.

Details

void __construct(Container $laravel, Dispatcher $events, string $version)

Create a new Artisan console application.

Parameters

Container $laravel
Dispatcher $events
string $version

Return Value

void

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

{@inheritdoc}

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

static string phpBinary()

Determine the proper PHP executable.

Return Value

string

static string artisanBinary()

Determine the proper Artisan executable.

Return Value

string

static string formatCommandString(string $string)

Format the given command as a fully-qualified executable command.

Parameters

string $string

Return Value

string

static void starting(Closure $callback)

Register a console "starting" bootstrapper.

Parameters

Closure $callback

Return Value

void

protected void bootstrap()

Bootstrap the console application.

Return Value

void

static void forgetBootstrappers()

Clear the console application bootstrappers.

Return Value

void

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

Run an Artisan console command by name.

Parameters

string $command
array $parameters
OutputInterface|null $outputBuffer

Return Value

int

Exceptions

CommandNotFoundException

protected array parseCommand(string $command, array $parameters)

Parse the incoming Artisan command and its input.

Parameters

string $command
array $parameters

Return Value

array

string output()

Get the output for the last run command.

Return Value

string

Command add(Command $command)

Add a command to the console.

Parameters

Command $command

Return Value

Command

protected Command addToParent(Command $command)

Add the command to the parent instance.

Parameters

Command $command

Return Value

Command

Command|null resolve(Command|string $command)

Add a command, resolving through the application.

Parameters

Command|string $command

Return Value

Command|null

$this resolveCommands(array|mixed $commands)

Resolve an array of commands through the application.

Parameters

array|mixed $commands

Return Value

$this

$this setContainerCommandLoader()

Set the container command loader for lazy resolution.

Return Value

$this

protected InputDefinition getDefaultInputDefinition()

Get the default input definition for the application.

This is used to add the --env option to every available command.

Return Value

InputDefinition

protected InputOption getEnvironmentOption()

Get the global environment option for the definition.

Return Value

InputOption

Application getLaravel()

Get the Laravel application instance.

Return Value

Application