Request::addOption() - Code Metrics - Inspection of "Rename Message to Notification. Add headers for Re..." - edamov/pushok - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9b760e...8a0b19 )

by Arthur

created 2016-11-08 16:49 UTC

Request::addOption() A

↳ Parent: Request

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2

<?php

/*
 * This file is part of the Pushok package.
 *
 * (c) Arthur Edamov <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Pushok;

/**
 * Class Request
 * @package Pushok
 *
 * @see http://bit.ly/communicating-with-apns
 */
class Request
{
    const APNS_DEVELOPMENT_SERVER = 'https://api.development.push.apple.com';
    const APNS_PRODUCTION_SERVER = 'https://api.push.apple.com';
    const APNS_PORT = 443;
    const APNS_PATH_SCHEMA = '/3/device/{token}';

    const HEADER_APNS_ID = 'apns-id';
    const HEADER_APNS_EXPIRATION = 'apns-expiration';
    const HEADER_APNS_PRIORITY = 'apns-priority';
    const HEADER_APNS_TOPIC = 'apns-topic';
    const HEADER_APNS_COLLAPSE_ID = 'apns-collapse-id';

    /**
     * Request headers.
     *
     * @var array
     */
    private $headers = [];

    /**
     * Curl options.
     *
     * @var array
     */
    private $options = [];

    public function __construct(Notification $notification, $isProductionEnv)
    {
        $url = $isProductionEnv ? $this->getProductionUrl($notification) : $this->getSandboxUrl($notification);

        if (!defined('CURL_HTTP_VERSION_2')) {
            define('CURL_HTTP_VERSION_2', 3);
        }

        $this->options = [
            CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_2,
            CURLOPT_URL => $url,
            CURLOPT_PORT => self::APNS_PORT,
            CURLOPT_POST => true,
            CURLOPT_POSTFIELDS => $notification->getPayload()->toJson(),
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_TIMEOUT => 30,
            CURLOPT_HEADER => true,
        ];

        $this->prepareApnsHeaders($notification);
    }

    /**
     * Add curl options.
     *
     * @param int $key
     * @param $value
     * @return Request
     */
    public function addOption(int $key, $value): Request
    {
        $this->options[$key] = $value;

        return $this;
    }

    /**
     * Add curl options.
     *
     * @param array $options
     * @return Request
     */
    public function addOptions(array $options): Request
    {
        $this->headers = array_merge($this->options, $options);

        return $this;
    }

    public function getOptions()
    {
        return $this->options;
    }

    /**
     * Add request header.
     *
     * @param string $header
     */
    public function addHeader(string $header)
    {
        $this->headers[] = $header;
    }

    /**
     * Add request headers.
     *
     * @param Notification[] $headers
     */
    public function addHeaders(array $headers)
    {
        $this->headers = array_merge($this->headers, $headers);
    }

    /**
     * Get request headers.
     *
     * @return array
     */
    public function getHeaders(): array
    {
        return $this->headers;
    }

    private function getProductionUrl(Notification $notification)
    {
        return self::APNS_PRODUCTION_SERVER . $this->getUrlPath($notification);
    }

    private function getSandboxUrl(Notification $notification)
    {
        return self::APNS_DEVELOPMENT_SERVER . $this->getUrlPath($notification);
    }

    private function getUrlPath(Notification $notification)
    {
        return str_replace("{token}", $notification->getDeviceToken(), self::APNS_PATH_SCHEMA);
    }

    private function prepareApnsHeaders(Notification $notification)
    {
        if ($notification->getId()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->headers[] = self::HEADER_APNS_ID . ': ' . $notification->getId();
        }

        if ($notification->getExpirationAt()) {
            $this->headers[] = self::HEADER_APNS_EXPIRATION . ': ' . $notification->getExpirationAt();
        }

        if ($notification->getPriority()) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $this->headers[] = self::HEADER_APNS_PRIORITY . ': ' . $notification->getPriority();
        }

        if ($notification->getCollapseId()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->headers[] = self::HEADER_APNS_COLLAPSE_ID . ': ' . $notification->getCollapseId();
        }
    }

}


1			<?php
2
3			/*
4			* This file is part of the Pushok package.
5			*
6			* (c) Arthur Edamov <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Pushok;
13
14			/**
15			* Class Request
16			* @package Pushok
17			*
18			* @see http://bit.ly/communicating-with-apns
19			*/
20			class Request
21			{
22			const APNS_DEVELOPMENT_SERVER = 'https://api.development.push.apple.com';
23			const APNS_PRODUCTION_SERVER = 'https://api.push.apple.com';
24			const APNS_PORT = 443;
25			const APNS_PATH_SCHEMA = '/3/device/{token}';
26
27			const HEADER_APNS_ID = 'apns-id';
28			const HEADER_APNS_EXPIRATION = 'apns-expiration';
29			const HEADER_APNS_PRIORITY = 'apns-priority';
30			const HEADER_APNS_TOPIC = 'apns-topic';
31			const HEADER_APNS_COLLAPSE_ID = 'apns-collapse-id';
32
33			/**
34			* Request headers.
35			*
36			* @var array
37			*/
38			private $headers = [];
39
40			/**
41			* Curl options.
42			*
43			* @var array
44			*/
45			private $options = [];
46
47			public function __construct(Notification $notification, $isProductionEnv)
48			{
49			$url = $isProductionEnv ? $this->getProductionUrl($notification) : $this->getSandboxUrl($notification);
50
51			if (!defined('CURL_HTTP_VERSION_2')) {
52			define('CURL_HTTP_VERSION_2', 3);
53			}
54
55			$this->options = [
56			CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_2,
57			CURLOPT_URL => $url,
58			CURLOPT_PORT => self::APNS_PORT,
59			CURLOPT_POST => true,
60			CURLOPT_POSTFIELDS => $notification->getPayload()->toJson(),
61			CURLOPT_RETURNTRANSFER => true,
62			CURLOPT_TIMEOUT => 30,
63			CURLOPT_HEADER => true,
64			];
65
66			$this->prepareApnsHeaders($notification);
67			}
68
69			/**
70			* Add curl options.
71			*
72			* @param int $key
73			* @param $value
74			* @return Request
75			*/
76			public function addOption(int $key, $value): Request
77			{
78			$this->options[$key] = $value;
79
80			return $this;
81			}
82
83			/**
84			* Add curl options.
85			*
86			* @param array $options
87			* @return Request
88			*/
89			public function addOptions(array $options): Request
90			{
91			$this->headers = array_merge($this->options, $options);
92
93			return $this;
94			}
95
96			public function getOptions()
97			{
98			return $this->options;
99			}
100
101			/**
102			* Add request header.
103			*
104			* @param string $header
105			*/
106			public function addHeader(string $header)
107			{
108			$this->headers[] = $header;
109			}
110
111			/**
112			* Add request headers.
113			*
114			* @param Notification[] $headers
115			*/
116			public function addHeaders(array $headers)
117			{
118			$this->headers = array_merge($this->headers, $headers);
119			}
120
121			/**
122			* Get request headers.
123			*
124			* @return array
125			*/
126			public function getHeaders(): array
127			{
128			return $this->headers;
129			}
130
131			private function getProductionUrl(Notification $notification)
132			{
133			return self::APNS_PRODUCTION_SERVER . $this->getUrlPath($notification);
134			}
135
136			private function getSandboxUrl(Notification $notification)
137			{
138			return self::APNS_DEVELOPMENT_SERVER . $this->getUrlPath($notification);
139			}
140
141			private function getUrlPath(Notification $notification)
142			{
143			return str_replace("{token}", $notification->getDeviceToken(), self::APNS_PATH_SCHEMA);
144			}
145
146			private function prepareApnsHeaders(Notification $notification)
147			{
148			if ($notification->getId()) {
			0 ignored issues – show Bug Best Practice introduced 2016-11-08 16:51 UTC by Report Bug Copy Issue Report The expression `$notification->getId()` 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...
149			$this->headers[] = self::HEADER_APNS_ID . ': ' . $notification->getId();
150			}
151
152			if ($notification->getExpirationAt()) {
153			$this->headers[] = self::HEADER_APNS_EXPIRATION . ': ' . $notification->getExpirationAt();
154			}
155
156			if ($notification->getPriority()) {
			0 ignored issues – show Bug Best Practice introduced 2016-11-08 16:51 UTC by Report Bug Copy Issue Report The expression `$notification->getPriority()` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be zero. 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 `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
157			$this->headers[] = self::HEADER_APNS_PRIORITY . ': ' . $notification->getPriority();
158			}
159
160			if ($notification->getCollapseId()) {
			0 ignored issues – show Bug Best Practice introduced 2016-11-08 16:51 UTC by Report Bug Copy Issue Report The expression `$notification->getCollapseId()` 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...
161			$this->headers[] = self::HEADER_APNS_COLLAPSE_ID . ': ' . $notification->getCollapseId();
162			}
163			}
164
165			}
166

edamov / pushok

Push — master ( 9b760e...8a0b19 )

Request::addOption() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like