class Illuminate / Console / Command
You're browsing the documentation for an upcoming version of Laravel. The documentation and features of this release are subject to change.

Command

Extends

    Symfony\...\Command

Uses

Properties

protected

$laravel Application

The Laravel application instance.

Default: null
protected

$signature string

The name and signature of the console command.

Default: null
protected

$name string

The console command name.

Default: null
protected

$description string|null

The console command description.

Default: null
protected

$help string

The console command help text.

Default: null
protected

$hidden bool

Indicates whether the command should be shown in the Artisan command list.

Default: false
protected

$isolated bool

Indicates whether only one instance of the command can run at any given time.

Default: false
protected

$isolatedExitCode int

The default exit code for isolated commands.

Default: SUCCESS
protected

$aliases array

The console command name aliases.

Default: null

Methods

public

__construct ( ) : void

Create a new console command instance.

protected

configureUsingFluentDefinition ( ) : void

Configure the console command using a fluent definition.

protected

configureIsolation ( ) : void

Configure the console command for isolation.

public

run ( Symfony\...\InputInterface $input , Symfony\...\OutputInterface $output ) : int

Run the console command.

Parameters

  • $input Symfony\...\InputInterface
  • $output Symfony\...\OutputInterface
protected

execute ( Symfony\...\InputInterface $input , Symfony\...\OutputInterface $output ) : int

Execute the console command.

Parameters

  • $input Symfony\...\InputInterface
  • $output Symfony\...\OutputInterface
protected

commandIsolationMutex ( ) : CommandMutex

Get a command isolation mutex instance for the command.

protected

resolveCommand ( $command ) : Symfony\...\Command

Resolve the console command instance for the given command.

Parameters

  • $command Symfony\...\Command|string
public

isHidden ( ) : bool

{@inheritdoc}

public

setHidden ( bool $hidden ) : void

{@inheritdoc}

public

getLaravel ( ) : Application

Get the Laravel application instance.

public

setLaravel ( $laravel ) : void

Set the Laravel application instance.

Parameters