W3cubDocs

/Laravel 8

BaseCommand

class BaseCommand extends Command (View source)

Traits

Properties

protected InputInterface	$input	The input interface implementation.	from InteractsWithIO
protected OutputStyle	$output	The output interface implementation.	from InteractsWithIO
protected int	$verbosity	The default verbosity of output commands.	from InteractsWithIO
protected array	$verbosityMap	The mapping between human readable verbosity levels and Symfony's OutputInterface.	from InteractsWithIO
static protected array	$macros	The registered string macros.	from Macroable
protected Application	$laravel	The Laravel application instance.	from Command
protected string	$signature	The name and signature of the console command.	from Command
protected string	$name	The console command name.	from Command
protected string\|null	$description	The console command description.	from Command
protected string\|null	$help	The console command help text.	from Command
protected bool	$hidden	Indicates whether the command should be shown in the Artisan command list.	from Command

Methods

Command

resolveCommand(Command|string $command)

Resolve the console command instance for the given command.

from CallsCommands

int

call(Command|string $command, array $arguments = [])

Call another console command.

from CallsCommands

int

callSilent(Command|string $command, array $arguments = [])

Call another console command silently.

from CallsCommands

int

runCommand(Command|string $command, array $arguments, OutputInterface $output)

Run the given the console command.

from CallsCommands

ArrayInput

createInputFromArguments(array $arguments)

Create an input instance from the given arguments.

from CallsCommands

array

context()

Get all of the context passed to the command.

from CallsCommands

void

specifyParameters()

Specify the arguments and options on the command.

from HasParameters

array

getArguments()

Get the console command arguments.

from HasParameters

array

getOptions()

Get the console command options.

from HasParameters

bool

hasArgument(string|int $name)

Determine if the given argument is present.

from InteractsWithIO

string|array|null

argument(string|null $key = null)

Get the value of a command argument.

from InteractsWithIO

array

arguments()

Get all of the arguments passed to the command.

from InteractsWithIO

bool

hasOption(string $name)

Determine if the given option is present.

from InteractsWithIO

string|array|bool|null

option(string|null $key = null)

Get the value of a command option.

from InteractsWithIO

array

options()

Get all of the options passed to the command.

from InteractsWithIO

bool

confirm(string $question, bool $default = false)

Confirm a question with the user.

from InteractsWithIO

mixed

ask(string $question, string|null $default = null)

Prompt the user for input.

from InteractsWithIO

mixed

anticipate(string $question, array|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

from InteractsWithIO

mixed

askWithCompletion(string $question, array|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

from InteractsWithIO

mixed

secret(string $question, bool $fallback = true)

Prompt the user for input but hide the answer from the console.

from InteractsWithIO

string|array

choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)

Give the user a single choice from an array of answers.

from InteractsWithIO

void

table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])

Format input to textual table.

from InteractsWithIO

void

info(string $string, int|string|null $verbosity = null)

Write a string as information output.

from InteractsWithIO

void

line(string $string, string|null $style = null, int|string|null $verbosity = null)

Write a string as standard output.

from InteractsWithIO

void

comment(string $string, int|string|null $verbosity = null)

Write a string as comment output.

from InteractsWithIO

void

question(string $string, int|string|null $verbosity = null)

Write a string as question output.

from InteractsWithIO

void

error(string $string, int|string|null $verbosity = null)

Write a string as error output.

from InteractsWithIO

void

warn(string $string, int|string|null $verbosity = null)

Write a string as warning output.

from InteractsWithIO

void

alert(string $string)

Write a string in an alert box.

from InteractsWithIO

void

newLine(int $count = 1)

Write a blank line.

from InteractsWithIO

void

setInput(InputInterface $input)

Set the input interface implementation.

from InteractsWithIO

void

setOutput(OutputStyle $output)

Set the output interface implementation.

from InteractsWithIO

void

setVerbosity(string|int $level)

Set the verbosity level.

from InteractsWithIO

int

parseVerbosity(string|int|null $level = null)

Get the verbosity level in terms of Symfony's OutputInterface level.

from InteractsWithIO

OutputStyle

getOutput()

Get the output implementation.

from InteractsWithIO

static void

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

from Macroable

static void

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

Mix another object into the class.

from Macroable

static bool

hasMacro(string $name)

Checks if macro is registered.

from Macroable

static mixed

__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable

mixed

__call(string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable

void

__construct()

Create a new console command instance.

from Command

void

configureUsingFluentDefinition()

Configure the console command using a fluent definition.

from Command

int

run(InputInterface $input, OutputInterface $output)

Run the console command.

from Command

int

execute(InputInterface $input, OutputInterface $output)

Execute the console command.

from Command

isHidden()

{@inheritdoc}

from Command

setHidden(bool $hidden)

{@inheritdoc}

from Command

Application

getLaravel()

Get the Laravel application instance.

from Command

void

setLaravel(Container $laravel)

Set the Laravel application instance.

from Command

array

getMigrationPaths()

Get all of the migration paths.

bool

usingRealPath()

Determine if the given path(s) are pre-resolved "real" paths.

string

getMigrationPath()

Get the path to the migration directory.

Details

abstract protected Command resolveCommand(Command|string $command)

Resolve the console command instance for the given command.

Parameters

Command|string

$command

Return Value

Command

int call(Command|string $command, array $arguments = [])

Call another console command.

Parameters

Command\|string	$command
array	$arguments

Return Value

int

int callSilent(Command|string $command, array $arguments = [])

Call another console command silently.

Parameters

Command\|string	$command
array	$arguments

Return Value

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

Run the given the console command.

Parameters

Command\|string	$command
array	$arguments
OutputInterface	$output

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

Create an input instance from the given arguments.

Parameters

array

$arguments

Return Value

ArrayInput

protected array context()

Get all of the context passed to the command.

Return Value

array

protected void specifyParameters()

Specify the arguments and options on the command.

Return Value

void

protected array getArguments()

Get the console command arguments.

Return Value

array

protected array getOptions()

Get the console command options.

Return Value

array

bool hasArgument(string|int $name)

Determine if the given argument is present.

Parameters

string|int

$name

Return Value

bool

string|array|null argument(string|null $key = null)

Get the value of a command argument.

Parameters

string|null

$key

Return Value

string|array|null

array arguments()

Get all of the arguments passed to the command.

Return Value

array

bool hasOption(string $name)

Determine if the given option is present.

Parameters

string

$name

Return Value

bool

string|array|bool|null option(string|null $key = null)

Get the value of a command option.

Parameters

string|null

$key

Return Value

string|array|bool|null

array options()

Get all of the options passed to the command.

Return Value

array

bool confirm(string $question, bool $default = false)

Confirm a question with the user.

Parameters

string	$question
bool	$default

Return Value

bool

mixed ask(string $question, string|null $default = null)

Prompt the user for input.

Parameters

string	$question
string\|null	$default

Return Value

mixed

mixed anticipate(string $question, array|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

Parameters

string	$question
array\|callable	$choices
string\|null	$default

Return Value

mixed

mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)

Prompt the user for input with auto completion.

Parameters

string	$question
array\|callable	$choices
string\|null	$default

Return Value

mixed

mixed secret(string $question, bool $fallback = true)

Prompt the user for input but hide the answer from the console.

Parameters

string	$question
bool	$fallback

Return Value

mixed

string|array choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)

Give the user a single choice from an array of answers.

Parameters

string	$question
array	$choices
string\|null	$default
mixed\|null	$attempts
bool	$multiple

Return Value

string|array

void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])

Format input to textual table.

Parameters

array	$headers
Arrayable\|array	$rows
string	$tableStyle
array	$columnStyles

Return Value

void

void info(string $string, int|string|null $verbosity = null)

Write a string as information output.

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

void line(string $string, string|null $style = null, int|string|null $verbosity = null)

Write a string as standard output.

Parameters

string	$string
string\|null	$style
int\|string\|null	$verbosity

Return Value

void

void comment(string $string, int|string|null $verbosity = null)

Write a string as comment output.

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

void question(string $string, int|string|null $verbosity = null)

Write a string as question output.

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

void error(string $string, int|string|null $verbosity = null)

Write a string as error output.

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

void warn(string $string, int|string|null $verbosity = null)

Write a string as warning output.

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

void alert(string $string)

Write a string in an alert box.

Parameters

string

$string

Return Value

void

void newLine(int $count = 1)

Write a blank line.

Parameters

int

$count

Return Value

void

void setInput(InputInterface $input)

Set the input interface implementation.

Parameters

InputInterface

$input

Return Value

void

void setOutput(OutputStyle $output)

Set the output interface implementation.

Parameters

OutputStyle

$output

Return Value

void

protected void setVerbosity(string|int $level)

Set the verbosity level.

Parameters

string|int

$level

Return Value

void

protected int parseVerbosity(string|int|null $level = null)

Get the verbosity level in terms of Symfony's OutputInterface level.

Parameters

string|int|null

$level

Return Value

int

OutputStyle getOutput()

Get the output implementation.

Return Value

OutputStyle

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

Mix another object into the class.

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string

$name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct()

Create a new console command instance.

Return Value

void

protected void configureUsingFluentDefinition()

Configure the console command using a fluent definition.

Return Value

void

int run(InputInterface $input, OutputInterface $output)

Run the console command.

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

int

protected int execute(InputInterface $input, OutputInterface $output)

Execute the console command.

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

int

isHidden()

{@inheritdoc}

setHidden(bool $hidden)

{@inheritdoc}

Parameters

bool

$hidden

Application getLaravel()

Get the Laravel application instance.

Return Value

Application

void setLaravel(Container $laravel)

Set the Laravel application instance.

Parameters

Container

$laravel

Return Value

void

protected array getMigrationPaths()

Get all of the migration paths.

Return Value

array

protected bool usingRealPath()

Determine if the given path(s) are pre-resolved "real" paths.

Return Value

bool

protected string getMigrationPath()

Get the path to the migration directory.

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Database/Console/Migrations/BaseCommand.html