synapse/php-shell

PHP wrapper for executing shell commands

1.1.1 2016-04-18 16:37 UTC

Requires (Dev)

• phpspec/phpspec: ^2.5

MIT

• Iain Earl

README

Introduction

PHP Shell was written to provide an OOP wrapper around shell command execution in PHP. It enables you to receive a response object from the command execution containing the stdout, stderr and exit code of the command.

Documentation

Basic usage

To create the command, pass an absolute path to the command for instantiation. You can also set where the command is executed using the setWorkingDirectory method.

$pwd = new Neuron\Shell\Command('/bin/pwd'); // CommandNotFoundException if the command is not executable
$pwd->setWorkingDirectory('/tmp'); // DirectoryDoesNotExistException if the directory is not found
$output = $pwd->execute();
var_dump($output->getStdout()); // string(5) "/tmp"
var_dump($output->getStderr()); // string(0) ""
var_dump($output->getExitCode()); // int(0)

Adding flags

$cmd = new Neuron\Shell\Command('/usr/local/bin/my_command');
$cmd->addShortFlag('v');
$cmd->addShortFlag('c', '/tmp/test.json');
$cmd->addLongFlag('version');
$cmd->addLongFlag('config', '/tmp/test.json');

Adding Arguments

$echo = new Neuron\Shell\Command('/bin/echo');
$echo->addArgument('hi there!');

Piping through another command

$cmd = new Neuron\Shell\Command('/usr/local/bin/my_command');
$cmd2 = new Neuron\Shell\Command('/usr/local/bin/my_command2');
$cmd->pipe($cmd2);
echo $cmd->getCmdString(); // "/usr/local/bin/my_command | /usr/local/bin/my_command2"

Searching Output

Check if the command was successful using the wasSuccessful method. Check if the output contains a certain string using the stdoutContains and stderrContains methods.

$echo = new \Neuron\Shell\Command('/bin/echo');
$echo->addArgument('fruit banana');
$output = $echo->execute();
var_dump($output->wasSuccessful()); // bool(true)
var_dump($output->stdoutContains('apple')); // bool(false)
var_dump($output->stdoutContains('banana')); // bool(true)

License

PHP Shell is open-sourced software licensed under the MIT license

Changelog

1.1.1

• Adding README info for pipe functionality

1.1.0

• Adding pipe functionality

1.0.0

• Initial Release