1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Console
  7. \
  8. Command

Command

abstract class Command extends Command (View source)

Constants

RETURN_CODE_ON_FAILURE

The return code we should return when an exception is thrown while running the command.
ALLOWASROOT_OPTION

The name of the CLI option that allows running CLI commands as root without confirmation.
ALLOWASROOT_ENV

The name of the environment variable that allows running CLI commands as root without confirmation.

Properties

protected bool $canRunAsRoot

Can this command be executed as root? If set to false, the command can be executed if one of these conditions is satisfied:

  • the users is not root
  • the --allow-as-root option is set
  • the C5_CLI_ALLOW_AS_ROOT environment variable is set
  • the console is interactive and the user explicitly confirm the operation.

Methods

run(InputInterface $input, OutputInterface $output)

{@inheritdoc}

initialize(InputInterface $input, OutputInterface $output)

{@inheritdoc}

writeError(OutputInterface $output, Exception|Throwable $error)

Write an exception.

$this
addEnvOption()

Add the "env" option to the command options.

$this
setCanRunAsRoot(bool $canRunAsRoot)

Allow/disallow running this command as root without confirmation.

bool|null
isRunningAsRoot()

Is the current user root?

confirmRunningAsRoot(InputInterface $input, OutputInterface $output)

No description

Details

at line 54
run(InputInterface $input, OutputInterface $output)

{@inheritdoc}

Parameters

InputInterface $input
OutputInterface $output

at line 73
protected initialize(InputInterface $input, OutputInterface $output)

{@inheritdoc}

Parameters

InputInterface $input
OutputInterface $output

See also

\Symfony\Component\Console\Command\Command::initialize()

at line 86
protected writeError(OutputInterface $output, Exception|Throwable $error)

Write an exception.

Parameters

OutputInterface $output
Exception|Throwable $error

at line 113
protected $this addEnvOption()

Add the "env" option to the command options.

Return Value

$this

at line 131
protected $this setCanRunAsRoot(bool $canRunAsRoot)

Allow/disallow running this command as root without confirmation.

Parameters

bool $canRunAsRoot

if false the command can be executed if one of these conditions is satisfied:

  • the users is not root
  • the --allow-as-root option is set
  • the C5_CLI_ALLOW_AS_ROOT environment variable is set
  • the console is interactive and the user explicitly confirm the operation

Return Value

$this

at line 158
protected bool|null isRunningAsRoot()

Is the current user root?

Return Value

bool|null

NULL if unknown, or boolean if determined

at line 171
protected confirmRunningAsRoot(InputInterface $input, OutputInterface $output)

No description

Parameters

InputInterface $input
OutputInterface $output

Exceptions

UserMessageException