phpbu\App\Cli\Result

Complexity

Total Complexity

10

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getCmd()	0	4	1
A	getCode()	0	4	1
A	wasSuccessful()	0	4	1
A	getStdOut()	0	4	1
A	getStdErr()	0	4	1
A	getStdOutAsArray()	0	7	2
A	textToBuffer()	0	4	1
A	__toString()	0	4	1

<?php
namespace phpbu\App\Cli;

/**
 * Runner 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
{
    /**
     * Command that got executed.
     *
     * @var string
     */
    private $cmd;

    /**
     * Result code
     *
     * @var integer
     */
    private $code;

    /**
     * Output buffer.
     *
     * @var array
     */
    private $buffer;

    /**
     * StdOut
     *
     * @var string
     */
    private $stdOut;

    /**
     * StdErr
     *
     * @var string
     */
    private $stdErr;

    /**
     * Constructor
     *
     * @param string  $cmd
     * @param integer $code
     * @param string  $stdOut
     * @param string  $stdErr
     */
    public function __construct($cmd, $code, $stdOut = '', $stdErr = '')
    {
        $this->cmd    = $cmd;
        $this->code   = $code;
        $this->stdOut = $stdOut;
        $this->stdErr = $stdErr;
    }

    /**
     * Cmd getter.
     *
     * @return string
     */
    public function getCmd()
    {
        return $this->cmd;
    }

    /**
     * Code getter.
     *
     * @return integer
     */
    public function getCode()
    {
        return $this->code;
    }

    /**
     * Command executed successful.
     */
    public function wasSuccessful()
    {
        return $this->code == 0;
    }

    /**
     * StdOutput getter.
     *
     * @return mixed array
     */
    public function getStdOut()
    {
        return $this->stdOut;
    }

    /**
     * StdError getter.
     *
     * @return mixed array
     */
    public function getStdErr()
    {
        return $this->stdErr;
    }

    /**
     * Return the output ins string format.
     *
     * @return string
     */
    public function getStdOutAsArray()
    {
        if (null === $this->buffer) {
            $this->buffer = $this->textToBuffer();
        }
        return $this->buffer;
    }

    /**
     * Converts the output buffer array into a string.
     *
     * @return string
     */
    private function textToBuffer()
    {
        return explode(PHP_EOL, $this->stdOut);
    }

    /**
     * Magic to string method.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->stdOut;
    }
}