Payever\ExternalIntegration\Core\Http\ResponseEntity

Complexity

Total Complexity

16

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setCall()	0	3	1
A	isFailed()	0	3	1
B	isValid()	0	7	8
A	setErrorDescription()	0	7	2
A	isSuccessful()	0	3	1
A	setError()	0	7	2
A	setResult()	0	3	1

<?php

/**
 * PHP version 5.4 and 8
 *
 * @category  Http
 * @package   Payever\Core
 * @author    payever GmbH <service@payever.de>
 * @copyright 2017-2021 payever GmbH
 * @license   MIT <https://opensource.org/licenses/MIT>
 * @link      https://docs.payever.org/shopsystems/api/getting-started
 */

namespace Payever\ExternalIntegration\Core\Http;

use Payever\ExternalIntegration\Core\Base\MessageEntity;
use Payever\ExternalIntegration\Core\Http\MessageEntity\CallEntity;
use Payever\ExternalIntegration\Core\Http\MessageEntity\ResultEntity;

/**
 * This class represents ResponseInterface Entity
 *
 * @method CallEntity   getCall()
 * @method string       getError()
 * @method string       getErrorDescription()
 * @method ResultEntity getResult()
 *
 * @SuppressWarnings(PHPMD.NumberOfChildren)
 */
class ResponseEntity extends MessageEntity
{
    /** @var CallEntity $call */
    protected $call;

    /** @var string $error */
    protected $error;

    /** @var string $errorDescription */
    protected $errorDescription;

    /** @var ResultEntity|array $result */
    protected $result;

    /**
     * Returns if Entity is successful
     *
     * @return bool
     */
    public function isSuccessful()
    {
        return empty($this->error);
    }

    /**
     * Returns if Entity is failed
     *
     * @return bool
     */
    public function isFailed()
    {
        return !$this->isSuccessful();
    }

    /**
     * {@inheritdoc}
     */
    public function isValid()
    {
        return parent::isValid() &&
            (!$this->call   || ($this->call   instanceof CallEntity   && $this->call->isValid())) &&
            (
                !$this->result || ($this->result instanceof ResultEntity && $this->result->isValid())
                || is_array($this->result)
            )
        ;
    }

    /**
     * Sets Call Entity
     *
     * @param array $call
     */
    public function setCall($call)
    {
        $this->call = new CallEntity($call);
    }

    /**
     * Sets Error Property
     *
     * @param array|string $error
     */
    public function setError($error)
    {
        if (is_array($error)) {
            $error = json_encode($error);
        }

        $this->error = $error;
    }

    /**
     * Sets ErrorDescription Property
     *
     * @param array|string $errorDescription
     */
    public function setErrorDescription($errorDescription)
    {
        if (is_array($errorDescription)) {
            $errorDescription = json_encode($errorDescription);
        }

        $this->errorDescription = $errorDescription;
    }

    /**
     * Sets Result Entity
     *
     * @param array $result
     */
    public function setResult($result)
    {
        $this->result = new ResultEntity($result);
    }
}