Response::getStatusCode() - Code Metrics - Inspection of "Add http adapter" - shetabit/multipay - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#109)

by mohammad

created 2021-10-05 15:00 UTC

Response::getStatusCode() A

↳ Parent: Response

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Shetabit\Multipay\Http;

use Carbon\Carbon;

class Response implements \ArrayAccess
{

    /**
     * Response Date.
     *
     * @var Carbon
     */
    protected $date;

    /**
     * Payment Driver.
     *
     * @var string
     */
    protected $driver;

    /**
     * Response Data.
     *
     * @var array
     */
    protected $data = [];

    /**
     * response status code
     * @var
     */
    protected $statusCode;

    /**
     * response status message
     * @var string[]
     */
    protected $statusMessages = [
        // INFORMATIONAL CODES
        100 => 'Continue',
        101 => 'Switching Protocols',
        102 => 'Processing',
        // SUCCESS CODES
        200 => 'OK',
        201 => 'Created',
        202 => 'Accepted',
        203 => 'Non-Authoritative Information',
        204 => 'No Content',
        205 => 'Reset Content',
        206 => 'Partial Content',
        207 => 'Multi-status',
        208 => 'Already Reported',
        226 => 'IM Used',
        // REDIRECTION CODES
        300 => 'Multiple Choices',
        301 => 'Moved Permanently',
        302 => 'Found',
        303 => 'See Other',
        304 => 'Not Modified',
        305 => 'Use Proxy',
        306 => 'Switch Proxy', // Deprecated
        307 => 'Temporary Redirect',
        308 => 'Permanent Redirect',
        // CLIENT ERROR
        400 => 'Bad Request',
        401 => 'Unauthorized',
        402 => 'Payment Required',
        403 => 'Forbidden',
        404 => 'Not Found',
        405 => 'Method Not Allowed',
        406 => 'Not Acceptable',
        407 => 'Proxy Authentication Required',
        408 => 'Request Time-out',
        409 => 'Conflict',
        410 => 'Gone',
        411 => 'Length Required',
        412 => 'Precondition Failed',
        413 => 'Request Entity Too Large',
        414 => 'Request-URI Too Long',
        415 => 'Unsupported Media Type',
        416 => 'Requested range not satisfiable',
        417 => 'Expectation Failed',
        418 => 'I\'m a teapot',
        422 => 'Unprocessable Entity',
        423 => 'Locked',
        424 => 'Failed Dependency',
        425 => 'Too Early',
        426 => 'Upgrade Required',
        428 => 'Precondition Required',
        429 => 'Too Many Requests',
        431 => 'Request Header Fields Too Large',
        444 => 'Connection Closed Without Response',
        451 => 'Unavailable For Legal Reasons',
        499 => 'Client Closed Request',
        // SERVER ERROR
        500 => 'Internal Server Error',
        501 => 'Not Implemented',
        502 => 'Bad Gateway',
        503 => 'Service Unavailable',
        504 => 'Gateway Time-out',
        505 => 'HTTP Version not supported',
        506 => 'Variant Also Negotiates',
        507 => 'Insufficient Storage',
        508 => 'Loop Detected',
        510 => 'Not Extended',
        511 => 'Network Authentication Required',
        599 => 'Network Connect Timeout Error',
    ];

    /**
     * Response constructor.
     *
     * @param string $driver
     * @param int $statusCode
     */
    public function __construct(string $driver, int $statusCode)
    {
        $this->driver = $driver;
        $this->statusCode = $statusCode;
        $this->date = Carbon::now();
    }


    /**
     * set Response Data.
     *
     * @param $key
     * @param null $value

     *
     * @return $this
     */
    public function data($key, $value = null) : self
    {
        $data = is_array($key) ? $key : [$key=>$value];

        $this->data = array_merge($this->data, $data);

        return $this;
    }

    /**
     * get Response Data.
     *
     * @param null $key

     *
     * @return mixed
     */
    public function getData($key = null)
    {
        return is_null($key)

            ? $this->data
            : $this->data[$key] ?? null;
    }
    /**
     * Get Response Date.
     *
     * @return Carbon
     */
    public function getDate(): Carbon
    {
        return $this->date;
    }

    /**
     * Get Response ArvanCloud Driver.
     *
     * @return string
     */
    public function getDriver(): string
    {
        return $this->driver;
    }

    /**
     * Get Response Message.
     *
     * @return string
     */
    public function getStatusCode(): string
    {
        return $this->statusCode;
    }

    /**
     * Check if request status is success
     * @return bool
     */
    public function isSuccess(): bool
    {
        $code = $this->getStatusCode();
        return  $code >= 200 && $code < 300;
    }

    /**
     * Is the request forbidden due to ACLs?
     *
     * @return bool
     */
    public function isForbidden(): bool
    {
        return (403 == $this->getStatusCode());
    }
    /**
     * Is the current status "informational"?
     *
     * @return bool
     */
    public function isInformational(): bool
    {
        $code = $this->getStatusCode();
        return ($code >= 100 && $code < 200);
    }

    /**
     * Does the status code indicate the resource is not found?
     *
     * @return bool
     */
    public function isNotFound(): bool
    {
        return (404 == $this->getStatusCode());
    }

    /**
     * Does the status code indicate the resource is gone?
     *
     * @return bool
     */
    public function isGone(): bool
    {
        return (410 == $this->getStatusCode());
    }

    /**
     * Do we have a normal, OK response?
     *
     * @return bool
     */
    public function isOk(): bool
    {
        return (200 == $this->getStatusCode());
    }

    /**
     * Does the status code reflect a server error?
     *
     * @return bool
     */
    public function isServerError(): bool
    {
        $code = $this->getStatusCode();
        return (500 <= $code && 600 > $code);
    }

    /**
     * Do we have a redirect?
     *
     * @return bool
     */
    public function isRedirect(): bool
    {
        $code = $this->getStatusCode();
        return (300 <= $code && 400 > $code);
    }
    /**
     * Get status message
     * @return string
     */
    public function getStatusMessages(): string
    {
        return $this->statusMessages[$this->getStatusCode()];
    }

    /**
     * Set status messages
     * @param $code
     * @param string|null $message
     */
    public function setStatusMessages($code, string $message = null)
    {
        $statusMessage = is_array($code) ? $code : [$code=>$message];
        $this->statusMessages = array_merge($this->statusMessages, $statusMessage);
    }

    /**
     * Throw Error if Request is Not Success
     * @param string $exception
     * @param string|null $message
     */
    public function throwError(string $exception, string $message = null)
    {
        if (! $this->isSuccess()) {
            throw new $exception($message??$this->getStatusMessages());
        }
    }

    /**
     * set Response Data.
     *
     * @param $name
     * @param $value
     */
    public function __set($name, $value)
    {
        $this->data($name, $value);
    }

    /**
     * get Response Data.
     *
     * @param $name
     *
     * @return mixed|null
     */
    public function __get($name)
    {
        return $this->GetData($name);
    }

    /**
     * @param mixed $offset
     *
     * @return bool
     */
    public function offsetExists($offset): bool
    {
        return isset($this->data[$offset]);
    }

    /**
     * @param mixed $offset
     *
     * @return mixed
     */
    public function offsetGet($offset)
    {
        return $this->data[$offset];
    }

    /**
     * @param mixed $offset
     * @param mixed $value
     *
     * @return mixed|void
     */
    public function offsetSet($offset, $value)
    {
        return $this->data[$offset] = $value;
    }

    /**
     * @param mixed $offset
     */
    public function offsetUnset($offset)
    {
        unset($this->data[$offset]);
    }
}


1			<?php
2
3			namespace Shetabit\Multipay\Http;
4
5			use Carbon\Carbon;
6
7			class Response implements \ArrayAccess
8			{
9
10			/**
11			* Response Date.
12			*
13			* @var Carbon
14			*/
15			protected $date;
16
17			/**
18			* Payment Driver.
19			*
20			* @var string
21			*/
22			protected $driver;
23
24			/**
25			* Response Data.
26			*
27			* @var array
28			*/
29			protected $data = [];
30
31			/**
32			* response status code
33			* @var
34			*/
35			protected $statusCode;
36
37			/**
38			* response status message
39			* @var string[]
40			*/
41			protected $statusMessages = [
42			// INFORMATIONAL CODES
43			100 => 'Continue',
44			101 => 'Switching Protocols',
45			102 => 'Processing',
46			// SUCCESS CODES
47			200 => 'OK',
48			201 => 'Created',
49			202 => 'Accepted',
50			203 => 'Non-Authoritative Information',
51			204 => 'No Content',
52			205 => 'Reset Content',
53			206 => 'Partial Content',
54			207 => 'Multi-status',
55			208 => 'Already Reported',
56			226 => 'IM Used',
57			// REDIRECTION CODES
58			300 => 'Multiple Choices',
59			301 => 'Moved Permanently',
60			302 => 'Found',
61			303 => 'See Other',
62			304 => 'Not Modified',
63			305 => 'Use Proxy',
64			306 => 'Switch Proxy', // Deprecated
65			307 => 'Temporary Redirect',
66			308 => 'Permanent Redirect',
67			// CLIENT ERROR
68			400 => 'Bad Request',
69			401 => 'Unauthorized',
70			402 => 'Payment Required',
71			403 => 'Forbidden',
72			404 => 'Not Found',
73			405 => 'Method Not Allowed',
74			406 => 'Not Acceptable',
75			407 => 'Proxy Authentication Required',
76			408 => 'Request Time-out',
77			409 => 'Conflict',
78			410 => 'Gone',
79			411 => 'Length Required',
80			412 => 'Precondition Failed',
81			413 => 'Request Entity Too Large',
82			414 => 'Request-URI Too Long',
83			415 => 'Unsupported Media Type',
84			416 => 'Requested range not satisfiable',
85			417 => 'Expectation Failed',
86			418 => 'I\'m a teapot',
87			422 => 'Unprocessable Entity',
88			423 => 'Locked',
89			424 => 'Failed Dependency',
90			425 => 'Too Early',
91			426 => 'Upgrade Required',
92			428 => 'Precondition Required',
93			429 => 'Too Many Requests',
94			431 => 'Request Header Fields Too Large',
95			444 => 'Connection Closed Without Response',
96			451 => 'Unavailable For Legal Reasons',
97			499 => 'Client Closed Request',
98			// SERVER ERROR
99			500 => 'Internal Server Error',
100			501 => 'Not Implemented',
101			502 => 'Bad Gateway',
102			503 => 'Service Unavailable',
103			504 => 'Gateway Time-out',
104			505 => 'HTTP Version not supported',
105			506 => 'Variant Also Negotiates',
106			507 => 'Insufficient Storage',
107			508 => 'Loop Detected',
108			510 => 'Not Extended',
109			511 => 'Network Authentication Required',
110			599 => 'Network Connect Timeout Error',
111			];
112
113			/**
114			* Response constructor.
115			*
116			* @param string $driver
117			* @param int $statusCode
118			*/
119			public function __construct(string $driver, int $statusCode)
120			{
121			$this->driver = $driver;
122			$this->statusCode = $statusCode;
123			$this->date = Carbon::now();
124			}
125
126
127			/**
128			* set Response Data.
129			*
130			* @param $key
131			* @param null $value
			0 ignored issues – show Documentation Bug introduced 2021-10-05 15:19 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$value` is correct as it would always require `null` to be passed? Loading history...
132			*
133			* @return $this
134			*/
135			public function data($key, $value = null) : self
136			{
137			$data = is_array($key) ? $key : [$key=>$value];
138
139			$this->data = array_merge($this->data, $data);
140
141			return $this;
142			}
143
144			/**
145			* get Response Data.
146			*
147			* @param null $key
			0 ignored issues – show Documentation Bug introduced 2021-10-05 15:19 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$key` is correct as it would always require `null` to be passed? Loading history...
148			*
149			* @return mixed
150			*/
151			public function getData($key = null)
152			{
153			return is_null($key)
			0 ignored issues – show introduced 2021-10-05 15:19 UTC by Report Bug Copy Issue Report The condition `is_null($key)` is always `true`. Loading history...
154			? $this->data
155			: $this->data[$key] ?? null;
156			}
157			/**
158			* Get Response Date.
159			*
160			* @return Carbon
161			*/
162			public function getDate(): Carbon
163			{
164			return $this->date;
165			}
166
167			/**
168			* Get Response ArvanCloud Driver.
169			*
170			* @return string
171			*/
172			public function getDriver(): string
173			{
174			return $this->driver;
175			}
176
177			/**
178			* Get Response Message.
179			*
180			* @return string
181			*/
182			public function getStatusCode(): string
183			{
184			return $this->statusCode;
185			}
186
187			/**
188			* Check if request status is success
189			* @return bool
190			*/
191			public function isSuccess(): bool
192			{
193			$code = $this->getStatusCode();
194			return $code >= 200 && $code < 300;
195			}
196
197			/**
198			* Is the request forbidden due to ACLs?
199			*
200			* @return bool
201			*/
202			public function isForbidden(): bool
203			{
204			return (403 == $this->getStatusCode());
205			}
206			/**
207			* Is the current status "informational"?
208			*
209			* @return bool
210			*/
211			public function isInformational(): bool
212			{
213			$code = $this->getStatusCode();
214			return ($code >= 100 && $code < 200);
215			}
216
217			/**
218			* Does the status code indicate the resource is not found?
219			*
220			* @return bool
221			*/
222			public function isNotFound(): bool
223			{
224			return (404 == $this->getStatusCode());
225			}
226
227			/**
228			* Does the status code indicate the resource is gone?
229			*
230			* @return bool
231			*/
232			public function isGone(): bool
233			{
234			return (410 == $this->getStatusCode());
235			}
236
237			/**
238			* Do we have a normal, OK response?
239			*
240			* @return bool
241			*/
242			public function isOk(): bool
243			{
244			return (200 == $this->getStatusCode());
245			}
246
247			/**
248			* Does the status code reflect a server error?
249			*
250			* @return bool
251			*/
252			public function isServerError(): bool
253			{
254			$code = $this->getStatusCode();
255			return (500 <= $code && 600 > $code);
256			}
257
258			/**
259			* Do we have a redirect?
260			*
261			* @return bool
262			*/
263			public function isRedirect(): bool
264			{
265			$code = $this->getStatusCode();
266			return (300 <= $code && 400 > $code);
267			}
268			/**
269			* Get status message
270			* @return string
271			*/
272			public function getStatusMessages(): string
273			{
274			return $this->statusMessages[$this->getStatusCode()];
275			}
276
277			/**
278			* Set status messages
279			* @param $code
280			* @param string\|null $message
281			*/
282			public function setStatusMessages($code, string $message = null)
283			{
284			$statusMessage = is_array($code) ? $code : [$code=>$message];
285			$this->statusMessages = array_merge($this->statusMessages, $statusMessage);
286			}
287
288			/**
289			* Throw Error if Request is Not Success
290			* @param string $exception
291			* @param string\|null $message
292			*/
293			public function throwError(string $exception, string $message = null)
294			{
295			if (! $this->isSuccess()) {
296			throw new $exception($message??$this->getStatusMessages());
297			}
298			}
299
300			/**
301			* set Response Data.
302			*
303			* @param $name
304			* @param $value
305			*/
306			public function __set($name, $value)
307			{
308			$this->data($name, $value);
309			}
310
311			/**
312			* get Response Data.
313			*
314			* @param $name
315			*
316			* @return mixed\|null
317			*/
318			public function __get($name)
319			{
320			return $this->GetData($name);
321			}
322
323			/**
324			* @param mixed $offset
325			*
326			* @return bool
327			*/
328			public function offsetExists($offset): bool
329			{
330			return isset($this->data[$offset]);
331			}
332
333			/**
334			* @param mixed $offset
335			*
336			* @return mixed
337			*/
338			public function offsetGet($offset)
339			{
340			return $this->data[$offset];
341			}
342
343			/**
344			* @param mixed $offset
345			* @param mixed $value
346			*
347			* @return mixed\|void
348			*/
349			public function offsetSet($offset, $value)
350			{
351			return $this->data[$offset] = $value;
352			}
353
354			/**
355			* @param mixed $offset
356			*/
357			public function offsetUnset($offset)
358			{
359			unset($this->data[$offset]);
360			}
361			}
362

shetabit / multipay

Pull Request — master (#109)

Response::getStatusCode() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like