phpbu\App\Cli\Result

Complexity

Total Complexity

11

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getCommandResult()	0	4	1
A	isSuccessful()	0	4	1
A	getReturnCode()	0	4	1
A	getCmd()	0	4	1
A	getCmdPrintable()	0	4	1
A	getStdOut()	0	4	1
A	getStdErr()	0	4	1
A	isOutputRedirected()	0	4	1
A	getRedirectPath()	0	4	1
A	getBufferedOutput()	0	4	1

<?php
namespace phpbu\App\Cli;

use SebastianFeldmann\Cli\Command\Result as CommandResult;

/**
 * Result
 *
 * @package    phpbu
 * @subpackage Backup
 * @author     Sebastian Feldmann <sebastian@phpbu.de>
 * @copyright  Sebastian Feldmann <sebastian@phpbu.de>
 * @license    https://opensource.org/licenses/MIT The MIT License (MIT)
 * @link       http://phpbu.de/
 * @since      Class available since Release 1.0.0
 */
class Result
{
    /**
     * Result of executed command.
     *
     * @var \SebastianFeldmann\Cli\Command\Result
     */
    private $cmdResult;

    /**
     * Command print safe.
     *
     * @var string
     */
    private $printableCmd;

    /**
     * Result constructor.
     *
     * @param \SebastianFeldmann\Cli\Command\Result $cmdResult
     * @param string                                $cmdPrintable
     */
    public function __construct(CommandResult $cmdResult, string $cmdPrintable = '')
    {
        $this->cmdResult    = $cmdResult;
        $this->printableCmd = $cmdPrintable;
    }

    /**
     * Get the raw command result.
     *
     * @return \SebastianFeldmann\Cli\Command\Result
     */
    public function getCommandResult() : CommandResult
    {
        return $this->cmdResult;
    }

    /**
     * Return true if command execution was successful.
     *
     * @return bool
     */
    public function isSuccessful() : bool
    {
        return $this->cmdResult->isSuccessful();
    }

    /**
     * Returns the raw cli return code.
     *
     * @return int
     */
    public function getReturnCode() : int
    {
        return $this->cmdResult->getCode();
    }

    /**
     * Return the executed cli command.
     *
     * @return string
     */
    public function getCmd() : string
    {
        return $this->cmdResult->getCmd();
    }

    /**
     * Return the executed cli command.
     *
     * @return string
     */
    public function getCmdPrintable() : string
    {
        return $this->printableCmd;
    }

    /**
     * Return commands output to stdOut.
     *
     * @return string
     */
    public function getStdOut() : string
    {
        return $this->cmdResult->getStdOut();
    }

    /**
     * Return commands error output to stdErr.
     *
     * @return string
     */
    public function getStdErr() : string
    {
        return $this->cmdResult->getStdErr();
    }

    /**
     * Is the output redirected to a file.
     *
     * @return bool
     */
    public function isOutputRedirected() : bool
    {
        return $this->cmdResult->isOutputRedirected();
    }

    /**
     * Return path to the file where the output is redirected to.
     *
     * @return string
     */
    public function getRedirectPath() : string
    {
        return $this->cmdResult->getRedirectPath();
    }

    /**
     * Return cmd output as array.
     *
     * @return array
     */
    public function getBufferedOutput() : array
    {
        return $this->cmdResult->getStdOutAsArray();
    }
}