treffynnon/lazyshell

This package is abandoned and no longer maintained. No replacement package was suggested.

Run shell commands from PHP the lazy way

v1.0.0 2016-03-16 23:25 UTC

Requires

• php: >5.6
• treffynnon/cmdwrap: ^1.0

Requires (Dev)

• phpunit/phpunit: ^5.2
• sebastian/phpcpd: ^2.0
• squizlabs/php_codesniffer: ^2.5

BSD

• Simon Holywell

• console
• command
• command line
• shell
• wrapper

README

A lazy way to make shell commands from PHP - handy for use from a REPL for instance. It uses my CmdWrap library underneath to provide the command building and process runners.

Installation

composer require treffynnon/lazyshell

Example

Sh::date("'+%Y-%m-%d'"); // date '+%Y-%m-%d'
$listing = Sh::ls('-lkha'); // ls -lkha

You can also modify the output by passing in a lambda or closure.

Sh::date("'+%Y-%m-%d'", function ($line) {
    return str_replace(date('Y'), '', $line);
})

The function is called against each line of output from the command.

Safety

Note that by default arguments will be passed in raw so you need to sanitise them before passing them to LazyShell. If you need escaping then you can pass in any of the CmdWrap types instead. I still would not allow user supplied variables go directly into commands though.

Sh::date(new Parameter('+%Y-%m-%d')); // date '+%Y-%m-%d'

Tests

Integration testing with phpunit and the code is also linted with php -l, phpcs and phpcpd. To run the tests you can use the following composer command:

composer test

Licence

BSD 2 clause licence - see LICENCE.md.