WebhookResponse::__construct() - Code Metrics - Inspection of "Added public user id processing for User Search we..." - xsolla/xsolla-sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#35)

unknown

created 2016-05-25 08:46 UTC

WebhookResponse::__construct() A

↳ Parent: WebhookResponse

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2.0078

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	11
rs	9.4285
ccs	7
cts	8
cp	0.875
cc	2
eloc	8
nc	2
nop	2
crap	2.0078

<?php

namespace Xsolla\SDK\Webhook;

use Symfony\Component\HttpFoundation\Response;
use Xsolla\SDK\API\XsollaClient;
use Xsolla\SDK\Exception\Webhook\XsollaWebhookException;
use Xsolla\SDK\Version;

class WebhookResponse
{
    /**
     * @var int
     */
    protected $httpStatusCode;

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

    /**
     * @var Response
     */
    protected $symfonyResponse;

    /**
     * @param \Exception $e
     *
     * @return WebhookResponse
     */
    public static function fromException(\Exception $e)
    {
        if ($e instanceof XsollaWebhookException) {
            return static::fromErrorCode($e->getXsollaErrorCode(), $e->getMessage(), $e->getHttpStatusCode());
        } else {
            return static::fromErrorCode('FATAL_ERROR', $e->getMessage());
        }
    }

    /**
     * @param string $xsollaErrorCode
     * @param string $message
     * @param int    $httpStatus
     *
     * @return WebhookResponse
     */
    public static function fromErrorCode($xsollaErrorCode, $message = '', $httpStatus = 500)
    {
        $body = array(
            'error' => array(
                'code' => $xsollaErrorCode,
                'message' => $message,
            ),
        );
        $encodedBody = XsollaClient::jsonEncode($body);

        return new static($httpStatus, $encodedBody);
    }

    /**
     * @param int    $httpStatusCode
     * @param string $body
     */
    public function __construct($httpStatusCode = 204, $body = null)
    {
        $this->symfonyResponse = new Response($body, $httpStatusCode);
        $this->symfonyResponse->headers->set('x-xsolla-sdk', Version::getVersion());
        if ($body) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $contentType = 'application/json';
        } else {
            $contentType = 'text/plain';
        }
        $this->symfonyResponse->headers->set('content-type', $contentType);
    }

    /**
     * @return Response
     */
    public function getSymfonyResponse()
    {
        return $this->symfonyResponse;
    }

    protected function validateStringParameter($name, $value)
    {
        if (!is_string($value)) {
            throw new XsollaWebhookException(sprintf(
                '%s should be non-empty string. %s given',
                $name,
                is_object($value) ? get_class($value) : gettype($value)
            ));
        }
        if ('' === $value) {
            throw new XsollaWebhookException($name.' should be non-empty string. Empty string given');
        }
    }
}


1		<?php
2
3		namespace Xsolla\SDK\Webhook;
4
5		use Symfony\Component\HttpFoundation\Response;
6		use Xsolla\SDK\API\XsollaClient;
7		use Xsolla\SDK\Exception\Webhook\XsollaWebhookException;
8		use Xsolla\SDK\Version;
9
10		class WebhookResponse
11		{
12		/**
13		* @var int
14		*/
15		protected $httpStatusCode;
16
17		/**
18		* @var string
19		*/
20		protected $body;
21
22		/**
23		* @var Response
24		*/
25		protected $symfonyResponse;
26
27		/**
28		* @param \Exception $e
29		*
30		* @return WebhookResponse
31		*/
32		public static function fromException(\Exception $e)
33		{
34		if ($e instanceof XsollaWebhookException) {
35		return static::fromErrorCode($e->getXsollaErrorCode(), $e->getMessage(), $e->getHttpStatusCode());
36		} else {
37		return static::fromErrorCode('FATAL_ERROR', $e->getMessage());
38		}
39		}
40
41		/**
42		* @param string $xsollaErrorCode
43		* @param string $message
44		* @param int $httpStatus
45		*
46		* @return WebhookResponse
47		*/
48		public static function fromErrorCode($xsollaErrorCode, $message = '', $httpStatus = 500)
49		{
50		$body = array(
51		'error' => array(
52		'code' => $xsollaErrorCode,
53		'message' => $message,
54		),
55		);
56		$encodedBody = XsollaClient::jsonEncode($body);
57
58		return new static($httpStatus, $encodedBody);
59		}
60
61		/**
62		* @param int $httpStatusCode
63		* @param string $body
64		*/
65	3	public function __construct($httpStatusCode = 204, $body = null)
66		{
67	3	$this->symfonyResponse = new Response($body, $httpStatusCode);
68	3	$this->symfonyResponse->headers->set('x-xsolla-sdk', Version::getVersion());
69	3	if ($body) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-08 10:43 UTC by Report Bug Copy Issue Report The expression `$body` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
70	3	$contentType = 'application/json';
71		} else {
72		$contentType = 'text/plain';
73		}
74	3	$this->symfonyResponse->headers->set('content-type', $contentType);
75	3	}
76
77		/**
78		* @return Response
79		*/
80	3	public function getSymfonyResponse()
81		{
82	3	return $this->symfonyResponse;
83		}
84
85	9	protected function validateStringParameter($name, $value)
86		{
87	9	if (!is_string($value)) {
88	4	throw new XsollaWebhookException(sprintf(
89	4	'%s should be non-empty string. %s given',
90		$name,
91	4	is_object($value) ? get_class($value) : gettype($value)
92		));
93		}
94	5	if ('' === $value) {
95	2	throw new XsollaWebhookException($name.' should be non-empty string. Empty string given');
96		}
97	3	}
98		}
99

xsolla / xsolla-sdk-php

Pull Request — master (#35)

WebhookResponse::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like