Inheritance diagram for Cli:

Public Member Functions
	__construct ($name='UNKNOWN', $version='UNKNOWN')

	doRun (Console\Input\InputInterface $input, Console\Output\OutputInterface $output)

Public Member Functions inherited from Application
	bootstrap (array $configuration)

Data Fields
const	INPUT_KEY_BOOTSTRAP = 'bootstrap'

const	RETURN_SUCCESS = 0

const	RETURN_FAILURE = 1

Protected Member Functions
	getDefaultCommands ()

	getVendorCommands ($objectManager)

Detailed Description

Magento 2 CLI Application. This is the hood for all command line tools supported by Magento.

{} @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 30 of file Cli.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$name = `'UNKNOWN'`,
		$version = `'UNKNOWN'`
	)

Parameters

string	$name	the application name
string	$version	the application version @SuppressWarnings(PHPMD.ExitExpression)

Definition at line 66 of file Cli.php.

     {
         try {
             $configuration = require BP . '/setup/config/application.config.php';
             $bootstrapApplication = new Application();
             $application = $bootstrapApplication->bootstrap($configuration);
             $this->serviceManager = $application->getServiceManager();
 
             $this->assertCompilerPreparation();
             $this->initObjectManager();
         } catch (\Exception $exception) {
             $output = new \Symfony\Component\Console\Output\ConsoleOutput();
             $output->writeln(
                 '<error>' . $exception->getMessage() . '</error>'
             );
 
             exit(static::RETURN_FAILURE);
         }
 
         if ($version == 'UNKNOWN') {
             $directoryList = new DirectoryList(BP);
             $composerJsonFinder = new ComposerJsonFinder($directoryList);
             $productMetadata = new ProductMetadata($composerJsonFinder);
             $version = $productMetadata->getVersion();
         }
 
         parent::__construct($name, $version);
     }

Member Function Documentation

◆ doRun()

doRun	(	Console\Input\InputInterface	$input,
		Console\Output\OutputInterface	$output
	)

{}

Exceptions

Definition at line 100 of file Cli.php.

     {
         $exitCode = parent::doRun($input, $output);
 
         if ($this->initException) {
             throw $this->initException;
         }
 
         return $exitCode;
     }

◆ getDefaultCommands()

getDefaultCommands ( )

protected

{}

Definition at line 114 of file Cli.php.

     {
         return array_merge(parent::getDefaultCommands(), $this->getApplicationCommands());
     }

◆ getVendorCommands()

getVendorCommands ( $objectManager )

protected

Retrieves vendor commands.

Parameters

ObjectManagerInterface $objectManager the object manager

Returns: array an array with external commands

Definition at line 204 of file Cli.php.

     {
         $commands = [];
         foreach (CommandLocator::getCommands() as $commandListClass) {
             if (class_exists($commandListClass)) {
                 $commands = array_merge(
                     $commands,
                     $objectManager->create($commandListClass)->getCommands()
                 );
             }
         }
 
         return $commands;
     }

Field Documentation

◆ INPUT_KEY_BOOTSTRAP

const INPUT_KEY_BOOTSTRAP = 'bootstrap'

Name of input option.

Definition at line 35 of file Cli.php.

◆ RETURN_FAILURE

const RETURN_FAILURE = 1

Definition at line 41 of file Cli.php.

◆ RETURN_SUCCESS

const RETURN_SUCCESS = 0

#+ Cli exit codes.

Definition at line 40 of file Cli.php.

The documentation for this class was generated from the following file:

vendor/magento/framework/Console/Cli.php

Public Member Functions

Data Fields

Protected Member Functions