artarts36/shell-command

OOP ShellCommand

2.1.15 2022-05-17 13:48 UTC

Requires

• php: ^7.3 || 8.*
• ext-mbstring: *
• artarts36/str: *

Requires (Dev)

• artarts36/php-cs-fixer-good-fixers: ^0.1.2
• phpstan/phpstan: ^1.4
• phpunit/phpunit: ^8.0
• squizlabs/php_codesniffer: 3.*

Suggests

• artarts36/shell-command-ssh-executor: *

MIT

• ArtARTs36

README

Installation:

Run: composer require artarts36/shell-command

Examples:

1. Arguments && Options

use ArtARTs36\ShellCommand\ShellCommand;

$command = ShellCommand::make('git')->addArgument('push')->addOption('force');

var_dump($command->__toString()); // git 'push' --force 2>&1

2. Execute Commands

use ArtARTs36\ShellCommand\ShellCommand;

$command = ShellCommand::make('git')->addArgument('pull');
$result = $command->execute();

var_dump($result->getCommandLine());
var_dump($result->getCode());
var_dump($result->getDate());
var_dump($result->getResult());
var_dump($result->getError());

3. SSH

To use ssh, you need to connect the library "artarts36/shell-command-ssh-executor":

Run command artarts36/shell-command-ssh-executor

$connection = \ArtARTs36\ShellCommandSshExecutor\SSH\Connection::withPassword(
    'remote.host',
    'user',
    'password'
);

$command = \ArtARTs36\ShellCommand\ShellCommand::make('ls');

$command->setExecutor(new \ArtARTs36\ShellCommandSshExecutor\SshCommandExecutor($connection));

var_dump($command->getShellResult());

4. Mocking

$executor = new \ArtARTs36\ShellCommand\Executors\TestExecutor();

$command = new \ArtARTs36\ShellCommand\ShellCommand('reboot');

$executor->addSuccess('OK');

$command->execute($executor);