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

InstallCommand

class InstallCommand 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.
private OPTIONPRECONDITIONS_ERROR

private OPTIONPRECONDITIONS_WARNINGS

private OPTIONPRECONDITIONS_SUCCESS

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.
 from  Command
private bool|null $preconditionsPassed
private Installer|null $configuredInstaller

Methods

run(InputInterface $input, OutputInterface $output)

{@inheritdoc}

from  Command
initialize(InputInterface $input, OutputInterface $output)

{@inheritdoc}

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

Write an exception.

from  Command
$this
addEnvOption()

Add the "env" option to the command options.

from  Command
$this
setCanRunAsRoot(bool $canRunAsRoot)

Allow/disallow running this command as root without confirmation.

from  Command
bool|null
isRunningAsRoot()

Is the current user root?

from  Command
confirmRunningAsRoot(InputInterface $input, OutputInterface $output)

No description

from  Command
configure()

No description

execute(InputInterface $input, OutputInterface $output)

No description

interact(InputInterface $input, OutputInterface $output)

No description

Question
getQuestion($row, InputInterface $input)

Do some procedural work to a row in the wizard step list to turn it into a proper question.

Generator|Question[]
getWizard(InputInterface $input, OutputInterface $output, null $firstKey = null)

A wizard generator.

string
getQuestionString(InputOption $option, $default)

Take an option and return a question string.

array
wizardSteps()

An array of steps Items: [ "option-name", "default-value", function($question, $input, $option) : $question ].

getPreconditionsPassed(Application $app, OutputInterface $output)

No description

bool
checkPreconditions(Application $app, OutputInterface $output)

No description

array
getFinalOptions(InputInterface $input)

No description

Installer
buildInstaller(array $options)

No description

int
checkOptionPreconditions(Application $app, Installer $installer, InputInterface $input, OutputInterface $output)

No description

Details

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

{@inheritdoc}

Parameters

InputInterface $input
OutputInterface $output

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

{@inheritdoc}

Parameters

InputInterface $input
OutputInterface $output

See also

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

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

Write an exception.

Parameters

OutputInterface $output
Exception|Throwable $error

in Command at line 113
protected $this addEnvOption()

Add the "env" option to the command options.

Return Value

$this

in Command 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

in Command at line 158
protected bool|null isRunningAsRoot()

Is the current user root?

Return Value

bool|null

NULL if unknown, or boolean if determined

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

No description

Parameters

InputInterface $input
OutputInterface $output

Exceptions

UserMessageException

at line 56
protected configure()

No description

at line 95
protected execute(InputInterface $input, OutputInterface $output)

No description

Parameters

InputInterface $input
OutputInterface $output

at line 195
protected interact(InputInterface $input, OutputInterface $output)

No description

Parameters

InputInterface $input
OutputInterface $output

at line 318
private Question getQuestion($row, InputInterface $input)

Do some procedural work to a row in the wizard step list to turn it into a proper question.

Parameters

$row
InputInterface $input

Return Value

Question

at line 377
private Generator|Question[] getWizard(InputInterface $input, OutputInterface $output, null $firstKey = null)

A wizard generator.

Parameters

InputInterface $input
OutputInterface $output
null $firstKey

Return Value

Generator|Question[]

at line 429
private string getQuestionString(InputOption $option, $default)

Take an option and return a question string.

Parameters

InputOption $option
$default

Return Value

string

at line 448
private array wizardSteps()

An array of steps Items: [ "option-name", "default-value", function($question, $input, $option) : $question ].

Return Value

array

at line 589
private getPreconditionsPassed(Application $app, OutputInterface $output)

No description

Parameters

Application $app
OutputInterface $output

at line 604
private bool checkPreconditions(Application $app, OutputInterface $output)

No description

Parameters

Application $app
OutputInterface $output

Return Value

bool

at line 674
private array getFinalOptions(InputInterface $input)

No description

Parameters

InputInterface $input

Return Value

array

at line 706
private Installer buildInstaller(array $options)

No description

Parameters

array $options

Return Value

Installer

at line 751
private int checkOptionPreconditions(Application $app, Installer $installer, InputInterface $input, OutputInterface $output)

No description

Parameters

Application $app
Installer $installer
InputInterface $input
OutputInterface $output

Return Value

int

One of the InstallCommand::OPTIONPRECONDITIONS_... constants