Shell Class Reference

Inheritance diagram for Shell:

Public Member Functions
	__construct (Driver $driver, LoggerInterface $logger)
	execute ($command, array $arguments=[])

Detailed Description

Class is separate from \Magento|Framework\Shell because logging behavior is different, and relies on ObjectManager being available.

Definition at line 19 of file Shell.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Driver	$driver,
		LoggerInterface	$logger
	)

Parameters

Driver	$driver
CommandRendererInterface	$commandRenderer
LoggerInterface	$logger

Definition at line 36 of file Shell.php.

      {
        $this->driver = $driver;
        $this->logger = $logger;
    }

Member Function Documentation

execute()

execute	(		$command,
		array	$arguments = []
	)

Execute a command through the command line, passing properly escaped arguments

Parameters

string	$command	Command with optional argument markers 's'
	string[]	$arguments Argument values to substitute markers with

Exceptions

Implements ShellInterface.

Definition at line 52 of file Shell.php.

    {
        try {
            $response = $this->driver->execute($command, $arguments);
        } catch (LocalizedException $e) {
            $this->logger->error($e->getLogMessage());
            throw $e;
        }
        $escapedCommand = $response->getEscapedCommand();
        $output = $response->getOutput();
        $exitCode = $response->getExitCode();
        $logEntry = $escapedCommand . PHP_EOL . $output;
        if ($exitCode) {
            $this->logger->error($logEntry);
            $commandError = new \Exception($output, $exitCode);
            throw new LocalizedException(
                new Phrase("Command returned non-zero exit code:\n`%1`", [$command]),
                $commandError
            );
        }
        $this->logger->info($logEntry);
        return $output;
    }

---

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

• vendor/magento/framework/App/Shell.php