ClubKonnectResponse::__toString() - Code Metrics - henryejemuta/laravel-clubkonnect - Measure and Improve Code Quality continuously with Scrutinizer

ClubKonnectResponse::__toString() A
last analyzed 2021-06-21 09:36 UTC

↳ Parent: ClubKonnectResponse

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php
/**
 * Created By: Henry Ejemuta
 * PC: Enrico Systems
 * Project: laravel-clubkonnect
 * Company: Stimolive Technologies Limited
 * Class Name: ClubKonnectResponse.php
 * Date Created: 9/27/20
 * Time Created: 6:00 PM
 */

namespace HenryEjemuta\LaravelClubKonnect\Classes;


use HenryEjemuta\LaravelClubKonnect\Enums\ClubKonnectStatusCodeEnum;
use HenryEjemuta\LaravelClubKonnect\Exceptions\ClubKonnectErrorException;

class ClubKonnectResponse
{
    private $message;

    /**
     * @var bool
     */
    private $hasError;

    /**
     * @var ClubKonnectErrorException
     */
    private $error;

    /**
     * @var int
     */
    private $code;

    /**
     * Response Body from
     * @var object|null $body
     */
    private $body;


    /**
     * ClubKonnectResponse constructor.
     * @param object|array|null $responseBody
     */
    public function __construct($responseBody = null)
    {
        if (isset($responseBody->status)) {
            $statusCode = ClubKonnectStatusCodeEnum::getStatusCode($responseBody->status);
            $this->code = $statusCode->getCode();
            $remark = ($responseBody->status == $statusCode->getRemark()) ? '' : $statusCode->getRemark();
            $this->message = $remark . (!empty($remark) ? ', ' : '') . $statusCode->getDescription();
        } else {
            $this->code = 200;
            $this->message = '';
        }

        $this->body = $responseBody;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->hasError = !in_array($this->code, ClubKonnectStatusCodeEnum::$successCodes);

        if ($this->hasError) {
            $this->error = new ClubKonnectErrorException($this->message, $this->code);
        } else {
            $this->error = null;
        }

    }

    /**
     * Determine if this is a success response object
     * @return bool
     */
    public function successful(): bool
    {
        return !($this->hasError);
    }

    /**
     * @return string
     */
    public function getCode(): string
    {
        return $this->code;
    }

    /**
     * @return string
     */
    public function getMessage(): string
    {
        return $this->message;
    }

    /**
     * Returns ClubKonnectErrorException with appropriate ClubKonnect status code and Message if this isn't a successful response, otherwise, null is returned
     * @return ClubKonnectErrorException|null
     */
    public function getErrorException()
    {
        return $this->error;
    }

    /**
     * Return the response body as specified in the ClubKunnect API documentation for the corresponding request. This would be null on fail request
     * @return object|array|null
     */
    public function getBody()
    {
        return $this->body;
    }

    public function __toString()
    {
        return json_encode($this->body);
    }

}


1			<?php
2			/**
3			* Created By: Henry Ejemuta
4			* PC: Enrico Systems
5			* Project: laravel-clubkonnect
6			* Company: Stimolive Technologies Limited
7			* Class Name: ClubKonnectResponse.php
8			* Date Created: 9/27/20
9			* Time Created: 6:00 PM
10			*/
11
12			namespace HenryEjemuta\LaravelClubKonnect\Classes;
13
14
15			use HenryEjemuta\LaravelClubKonnect\Enums\ClubKonnectStatusCodeEnum;
16			use HenryEjemuta\LaravelClubKonnect\Exceptions\ClubKonnectErrorException;
17
18			class ClubKonnectResponse
19			{
20			private $message;
21
22			/**
23			* @var bool
24			*/
25			private $hasError;
26
27			/**
28			* @var ClubKonnectErrorException
29			*/
30			private $error;
31
32			/**
33			* @var int
34			*/
35			private $code;
36
37			/**
38			* Response Body from
39			* @var object\|null $body
40			*/
41			private $body;
42
43
44			/**
45			* ClubKonnectResponse constructor.
46			* @param object\|array\|null $responseBody
47			*/
48			public function __construct($responseBody = null)
49			{
50			if (isset($responseBody->status)) {
51			$statusCode = ClubKonnectStatusCodeEnum::getStatusCode($responseBody->status);
52			$this->code = $statusCode->getCode();
53			$remark = ($responseBody->status == $statusCode->getRemark()) ? '' : $statusCode->getRemark();
54			$this->message = $remark . (!empty($remark) ? ', ' : '') . $statusCode->getDescription();
55			} else {
56			$this->code = 200;
57			$this->message = '';
58			}
59
60			$this->body = $responseBody;
			0 ignored issues – show Documentation Bug introduced 2021-05-28 08:57 UTC by Report Bug Copy Issue Report It seems like `$responseBody` can also be of type `array`. However, the property `$body` is declared as type `object\|null`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
61			$this->hasError = !in_array($this->code, ClubKonnectStatusCodeEnum::$successCodes);
62
63			if ($this->hasError) {
64			$this->error = new ClubKonnectErrorException($this->message, $this->code);
65			} else {
66			$this->error = null;
67			}
68
69			}
70
71			/**
72			* Determine if this is a success response object
73			* @return bool
74			*/
75			public function successful(): bool
76			{
77			return !($this->hasError);
78			}
79
80			/**
81			* @return string
82			*/
83			public function getCode(): string
84			{
85			return $this->code;
86			}
87
88			/**
89			* @return string
90			*/
91			public function getMessage(): string
92			{
93			return $this->message;
94			}
95
96			/**
97			* Returns ClubKonnectErrorException with appropriate ClubKonnect status code and Message if this isn't a successful response, otherwise, null is returned
98			* @return ClubKonnectErrorException\|null
99			*/
100			public function getErrorException()
101			{
102			return $this->error;
103			}
104
105			/**
106			* Return the response body as specified in the ClubKunnect API documentation for the corresponding request. This would be null on fail request
107			* @return object\|array\|null
108			*/
109			public function getBody()
110			{
111			return $this->body;
112			}
113
114			public function __toString()
115			{
116			return json_encode($this->body);
117			}
118
119			}
120

henryejemuta / laravel-clubkonnect

ClubKonnectResponse::__toString() A last analyzed 2021-06-21 09:36 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ClubKonnectResponse::__toString() A
last analyzed 2021-06-21 09:36 UTC