Executioner (executer) is a PHP library for executing system processes and applications with the ability to pass extra arguments and read CLI output results.
PHP
Latest commit a0d08b4 Dec 25, 2015 @allebb README updates.
Permalink
Failed to load latest commit information.
examples
src
.gitignore
LICENSE
README.md
composer.json
composer.lock

README.md

Executioner

Executioner is a PHP library for executing system processes and applications with the ability to pass extra arguments and read CLI output results.

Requirements

This library is developed and tested for PHP 5.4+

License

This client library is released under the MIT license, a copy of the license is provided in this package.

Installation

To install the package into your project (assuming you are using the Composer package manager) you can simply execute the following command from your terminal in the root of your project folder:

composer require ballen/executioner

Alternatively you can manually add this library to your project using the following steps, simply edit your project's composer.json file and add the following lines (or update your existing require section with the library like so):

"require": {
        "ballen/executioner": "^3.0"
}

Then install the package like so:

composer update ballen/executioner

Usage example

Example of retrieving IP address information for the server.


use Ballen\Executioner\Executioner;

$run = new Executioner();

if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
    $run->setApplication('ipconfig'); // Server is Microsoft Windows!
} else {
    $run->sudo() // Lets assume we must run 'sudo' to get the output...
        ->setApplication('ifconfig');
}
$run->execute();

// We'll simply just display the results as a plain text string...
echo $run->resultAsText();

An example of getting the PHP version number using php -v terminal command.

use Ballen\Executioner\Executioner;

/**
 * A shorthand version of using the factory method to create a new instance
 * and then chaining the other methods and getting the response.
 */
$php_version = Executioner::make('php')
    ->addArgument('-v')
    ->execute()
    ->resultAsArray();
$words = explode(' ', $php_version[0]); // Split the words from the first line of the output!
$extracted_version_number = $words[1]; // The second word in the raw outputted line should be the version number :)
echo 'The extacted version number is: ' . $extracted_version_number . '';

// The extacted version number is: 7.0.0

These examples can also be found in the examples directory.

Support

I am happy to provide support via. my personal email address, so if you need a hand drop me an email at: ballen@bobbyallen.me.