Shell Class Reference

Inheritance diagram for Shell:

Public Member Functions
	__construct (CommandRendererInterface $commandRenderer, \Psr\Log\LoggerInterface $logger=null)
	execute ($command, array $arguments=[])

Protected Member Functions
	log ($message)

Protected Attributes
	$logger

Detailed Description

Shell command line wrapper encapsulates command execution and arguments escaping

Definition at line 14 of file Shell.php.

Constructor & Destructor Documentation

__construct()

__construct	(	CommandRendererInterface	$commandRenderer,
		\Psr\Log\LoggerInterface	$logger = null
	)

Parameters

CommandRendererInterface	$commandRenderer
\Psr\Log\LoggerInterface	$logger	Logger instance to be used to log commands and their output

Definition at line 32 of file Shell.php.

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

Member Function Documentation

execute()

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

Execute a command through the command line, passing properly escaped arguments, and return its output

Parameters

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

Returns

string Output of an executed command

Exceptions

Implements ShellInterface.

Definition at line 48 of file Shell.php.

    {
        $command = $this->commandRenderer->render($command, $arguments);
        $this->log($command);

        $disabled = explode(',', str_replace(' ', ',', ini_get('disable_functions')));
        if (in_array('exec', $disabled)) {
            throw new Exception\LocalizedException(new \Magento\Framework\Phrase('The exec function is disabled.'));
        }

        exec($command, $output, $exitCode);
        $output = implode(PHP_EOL, $output);
        $this->log($output);

        if ($exitCode) {
            $commandError = new \Exception($output, $exitCode);
            throw new Exception\LocalizedException(
                new \Magento\Framework\Phrase("Command returned non-zero exit code:\n`%1`", [$command]),
                $commandError
            );
        }
        return $output;
    }

log()

log (   $message )

protected

Log a message, if a logger is specified

Parameters

string

$message

Returns

void

Definition at line 78 of file Shell.php.

    {
        if ($this->logger) {
            $this->logger->info($message);
        }
    }

Field Documentation

$logger

$logger

protected

Definition at line 21 of file Shell.php.

---

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

• vendor/magento/framework/Shell.php