SebastianFeldmann\Cli\Command\Executable

Complexity

Total Complexity

17

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getCommand()	0	6	3
A	getAcceptableExitCodes()	0	4	1
A	silence()	0	5	2
A	addOption()	0	15	3
A	addOptionIfNotEmpty()	0	11	3
A	addArgument()	0	5	1
A	escapeArgument()	0	10	2
A	__toString()	0	4	1

<?php

/**
 * This file is part of SebastianFeldmann\Cli.
 *
 * (c) Sebastian Feldmann <sf@sebastian-feldmann.info>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace SebastianFeldmann\Cli\Command;

use SebastianFeldmann\Cli\Command;

/**
 * Class Executable
 *
 * @package SebastianFeldmann\Cli
 * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>
 * @link    https://github.com/sebastianfeldmann/cli
 * @since   Class available since Release 0.9.0
 */
class Executable implements Command
{
    /**
     * Command name
     *
     * @var string
     */
    private $cmd;

    /**
     * Display stdErr
     *
     * @var boolean
     */
    private $isSilent = false;

    /**
     * Command options
     *
     * @var string[]
     */
    private $options = [];

    /**
     * List of acceptable exit codes.
     *
     * @var array
     */
    private $acceptableExitCodes = [];

    /**
     * Constructor.
     *
     * @param string $cmd
     * @param int[]  $exitCodes
     */
    public function __construct(string $cmd, array $exitCodes = [0])
    {
        $this->cmd                 = $cmd;
        $this->acceptableExitCodes = $exitCodes;
    }

    /**
     * Returns the string to execute on the command line.
     *
     * @return string
     */
    public function getCommand(): string
    {
        return $this->cmd
        . (count($this->options)   ? ' ' . implode(' ', $this->options)   : '')
        . ($this->isSilent         ? ' 2> /dev/null'                      : '');
    }

    /**
     * Returns a list of exit codes that are valid.
     *
     * @return int[]
     */
    public function getAcceptableExitCodes(): array
    {
        return $this->acceptableExitCodes;
    }

    /**
     * Silence the 'Cmd' by redirecting its stdErr output to /dev/null.
     * The silence feature is disabled for Windows systems.
     *
     * @param  bool $bool
     * @return \SebastianFeldmann\Cli\Command\Executable
     */
    public function silence($bool = true): Executable
    {
        $this->isSilent = $bool && !defined('PHP_WINDOWS_VERSION_BUILD');
        return $this;
    }

    /**
     * Add option to list.
     *
     * @param  string               $option
     * @param  mixed                $value
     * @param  string               $glue
     * @return \SebastianFeldmann\Cli\Command\Executable
     */
    public function addOption(string $option, $value = null, string $glue = '='): Executable
    {
        if ($value !== null) {
            // force space for multiple arguments e.g. --option 'foo' 'bar'
            if (is_array($value)) {
                $glue = ' ';
            }
            $value = $glue . $this->escapeArgument($value);
        } else {
            $value = '';
        }
        $this->options[] = $option . $value;

        return $this;
    }

    /**
     * Adds an option to a command if it is not empty.
     *
     * @param  string $option
     * @param  mixed  $check
     * @param  bool   $asValue
     * @param  string $glue
     * @return \SebastianFeldmann\Cli\Command\Executable
     */
    public function addOptionIfNotEmpty(string $option, $check, bool $asValue = true, string $glue = '='): Executable
    {
        if (!empty($check)) {
            if ($asValue) {
                $this->addOption($option, $check, $glue);
            } else {
                $this->addOption($option);
            }
        }
        return $this;
    }

    /**
     * Add argument to list.
     *
     * @param  mixed $argument
     * @return \SebastianFeldmann\Cli\Command\Executable
     */
    public function addArgument($argument): Executable
    {
        $this->options[] = $this->escapeArgument($argument);
        return $this;
    }

    /**
     * Escape a shell argument.
     *
     * @param  mixed $argument
     * @return string
     */
    protected function escapeArgument($argument): string
    {
        if (is_array($argument)) {
            $argument = array_map('escapeshellarg', $argument);
            $escaped  = implode(' ', $argument);
        } else {
            $escaped = escapeshellarg($argument);
        }
        return $escaped;
    }

    /**
     * Returns the command to execute.
     *
     * @return string
     */
    public function __toString(): string
    {
        return $this->getCommand();
    }
}