TQ\Vcs\Cli\CallResult

Complexity

Total Complexity

16

Size/Duplication

Total Lines	202
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

92%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	17	1
A	__destruct()	0	4	1
A	getCliCall()	0	4	1
A	getStdOutStream()	0	4	1
A	getStdOut()	0	5	1
A	hasStdOut()	0	4	1
A	getStdErrStream()	0	4	1
A	getStdErr()	0	5	1
A	hasStdErr()	0	4	1
A	getReturnCode()	0	4	1
A	assertSuccess()	0	4	1
A	throwIfError()	0	6	2
A	close()	0	11	3

<?php
/*
 * Copyright (C) 2017 by TEQneers GmbH & Co. KG
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

/**
 * Git Stream Wrapper for PHP
 *
 * @category   TQ
 * @package    TQ_VCS
 * @subpackage VCS
 * @copyright  Copyright (C) 2018 by TEQneers GmbH & Co. KG
 */

namespace TQ\Vcs\Cli;

/**
 * The result of a CLI call - provides access to stdout, stderror and the return code
 *
 * @author     Stefan Gehrig <gehrigteqneers.de>
 * @category   TQ
 * @package    TQ_VCS
 * @subpackage VCS
 * @copyright  Copyright (C) 2018 by TEQneers GmbH & Co. KG
 */
class CallResult
{
    /**
     * The stdout stream
     *
     * @var resource
     */
    protected $stdOut;

    /**
     * True if there is a stdout
     *
     * @var boolean
     */
    protected $hasStdOut;

    /**
     * The stderr stream
     *
     * @var resource
     */
    protected $stdErr;

    /**
     * True if there is a stderr
     *
     * @var boolean
     */
    protected $hasStdErr;

    /**
     * The return code
     *
     * @var integer
     */
    protected $returnCode;

    /**
     * Reference to the call that resulted in this result
     *
     * @var Call
     */
    protected $cliCall;

    /**
     * Creates a new result container for a CLI call
     *
     * @param   Call       $cliCall       Reference to the call that resulted in this result
     * @param   resource   $stdOut        The stdout stream
     * @param   resource   $stdErr        The stderr stream
     * @param   integer    $returnCode    The return code
     */
    public function __construct(Call $cliCall, $stdOut, $stdErr, $returnCode)
    {
        fseek($stdOut, 0, SEEK_END);
        $hasStdOut  = (ftell($stdOut) > 0);
        fseek($stdOut, 0, SEEK_SET);

        fseek($stdErr, 0, SEEK_END);
        $hasStdErr  = (ftell($stdErr) > 0);
        fseek($stdErr, 0, SEEK_SET);

        $this->cliCall      = $cliCall;
        $this->stdOut       = $stdOut;
        $this->hasStdOut    = $hasStdOut;
        $this->stdErr       = $stdErr;
        $this->hasStdErr    = $hasStdErr;
        $this->returnCode   = (int)$returnCode;
    }

    /**
     * Destructor closes the result and the internal stream resources
     */
    public function __destruct()
    {
        $this->close();
    }

    /**
     * Returns the reference to the call that resulted in this result
     *
     * @return Call
     */
    public function getCliCall()
    {
        return $this->cliCall;
    }

    /**
     * Returns the stdout stream
     *
     * @return resource
     */
    public function getStdOutStream()
    {
        return $this->stdOut;
    }

    /**
     * Returns the contents of stdout
     *
     * @return string
     */
    public function getStdOut()
    {
        fseek($this->stdOut, 0, SEEK_SET);
        return rtrim(stream_get_contents($this->stdOut));
    }

    /**
     * Returns true if the call resulted in stdout to be populated
     *
     * @return  boolean
     */
    public function hasStdOut()
    {
        return $this->hasStdOut;
    }

    /**
     * Returns the stderr stream
     *
     * @return resource
     */
    public function getStdErrStream()
    {
        return $this->stdErr;
    }

    /**
     * Returns the contents of stderr
     *
     * @return string
     */
    public function getStdErr()
    {
        fseek($this->stdErr, 0, SEEK_SET);
        return rtrim(stream_get_contents($this->stdErr));
    }

    /**
     * Returns true if the call resulted in stderr to be populated
     *
     * @return  boolean
     */
    public function hasStdErr()
    {
        return $this->hasStdErr;
    }

    /**
     * Returns the return code
     *
     * @return integer
     */
    public function getReturnCode()
    {
        return $this->returnCode;
    }

    /**
     * Closes the call result and the internal stream resources
     *
     * Prevents further usage
     */
    public function close()
    {
        if ($this->stdOut !== null) {
            fclose($this->stdOut);
            $this->stdOut   = null;
        }
        if ($this->stdErr !== null) {
            fclose($this->stdErr);
            $this->stdErr   = null;
        }
    }

    /**
     * Checks if the CLI call has succeeded and throws an Exception otherwise
     *
     * @param   string      $message        The exception message
     * @throws  CallException               If there has been an error when executing
     */
    public function assertSuccess($message)
    {
        self::throwIfError($this, $message);
    }

    /**
     * Checks if the CLI call has succeeded and throws an Exception otherwise
     *
     * @param   CallResult  $result         The CLI result
     * @param   string      $message        The exception message
     * @throws  CallException               If there has been an error when executing
     */
    public static function throwIfError(CallResult $result, $message)
    {
        if ($result->getReturnCode() > 0) {
            throw new CallException($message, $result);
        }
    }
}