Payload::getUrlArgs() - Code Metrics - Inspection of "Safari notifications support (#115)" - edamov/pushok - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b69afb...26655b )

by Arthur

created 2020-10-28 13:34 UTC

Payload::getUrlArgs() A

↳ Parent: Payload

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?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;

use Countable;
use Pushok\Payload\Alert;

// Polyfill for PHP 7.2
if (!function_exists('is_countable')) {
    function is_countable($var)
    {
        return (is_array($var) || $var instanceof Countable);
    }
}

/**
 * Class Payload
 *
 * @package Pushok
 *
 * @see     http://bit.ly/payload-key-reference
 */
class Payload implements \JsonSerializable
{
    const PAYLOAD_ROOT_KEY = 'aps';
    const PAYLOAD_ALERT_KEY = 'alert';
    const PAYLOAD_BADGE_KEY = 'badge';
    const PAYLOAD_SOUND_KEY = 'sound';
    const PAYLOAD_CONTENT_AVAILABLE_KEY = 'content-available';
    const PAYLOAD_MUTABLE_CONTENT_KEY = 'mutable-content';
    const PAYLOAD_CATEGORY_KEY = 'category';
    const PAYLOAD_THREAD_ID_KEY = 'thread-id';
    const PAYLOAD_URL_ARGS_KEY = 'url-args';

    const PAYLOAD_HTTP2_REGULAR_NOTIFICATION_MAXIMUM_SIZE = 4096;
    const PAYLOAD_HTTP2_VOIP_NOTIFICATION_MAXIMUM_SIZE = 5120;
    const PAYLOAD_BINARY_REGULAR_NOTIFICATION_MAXIMUM_SIZE = 2048;

    /**
     * The notification settings for your app on the user’s device determine whether an alert or banner is displayed.
     *
     * @var Alert|string
     */
    private $alert;

    /**
     * The number to display as the badge of the app icon.
     * If this property is absent, the badge is not changed.
     *
     * @var int
     */
    private $badge;

    /**
     * The name of a sound file in the app bundle or in the Library/Sounds folder of the app’s data container.
     *
     * @var string
     */
    private $sound;

    /**
     * Include this key with a value of true to configure a silent notification.
     *
     * @var bool
     */
    private $contentAvailable;

    /**
     * Include this key with a value of true to configure a mutable content notification.
     *
     * @var bool
     */
    private $mutableContent;

    /**
     * Provide this key with a string value that represents the notification’s type.
     *
     * @var string
     */
    private $category;

    /**
     * Provide this key with a string value that represents the app-specific identifier for grouping notifications.
     *
     * @var string
     */
    private $threadId;

    /**
     * Provide this key with an array value that represents the url-args for Safari notifications.
     *
     * @var string
     */
    private $urlArgs;

    /**
     * Payload custom values.
     *
     * @var array
     */
    private $customValues;

    /**
     * Push notification type
     *
     * https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns#2947607
     *
     * @var string
     */
    private $pushType;

    protected function __construct()
    {
    }

    /**
     * @return Payload
     */
    public static function create(): Payload
    {
        return new self();
    }

    /**
     * Get Alert.
     *
     * @return Alert|null
     */
    public function getAlert()
    {
        return $this->alert;
    }

    /**
     * Set Alert.
     *
     * @param Alert|string $alert
     *
     * @return Payload
     */
    public function setAlert($alert): Payload
    {
        if ($alert instanceof Alert || is_string($alert)) {
            $this->alert = $alert;
        }

        return $this;
    }

    /**
     * Get badge.
     *
     * @return int|null
     */
    public function getBadge()
    {
        return $this->badge;
    }

    /**
     * Set badge.
     *
     * @param int $value
     *
     * @return Payload
     */
    public function setBadge(int $value): Payload
    {
        $this->badge = $value;

        return $this;
    }

    /**
     * Get sound.
     *
     * @return string|null
     */
    public function getSound()
    {
        return $this->sound;
    }

    /**
     * Set sound.
     *
     * @param string $value
     *
     * @return Payload
     */
    public function setSound(string $value): Payload
    {
        $this->sound = $value;

        return $this;
    }

    /**
     * Set content availability.
     *
     * @param bool $value
     *
     * @return Payload
     */
    public function setContentAvailability(bool $value): Payload
    {
        $this->contentAvailable = $value;

        return $this;
    }

    /**
     * Get content availability.
     *
     * @return bool|null
     */
    public function isContentAvailable()
    {
        return $this->contentAvailable;
    }

    /**
     * Set the mutable-content key for Notification Service Extensions on iOS10.
     *
     * @see http://bit.ly/mutable-content
     *
     * @param bool $value
     *
     * @return Payload
     */
    public function setMutableContent(bool $value): Payload
    {
        $this->mutableContent = $value;

        return $this;
    }

    /**
     * Is content mutable.
     *
     * @return bool|null
     */
    public function hasMutableContent()
    {
        return $this->mutableContent;
    }

    /**
     * Get category.
     *
     * @return string|null
     */
    public function getCategory()
    {
        return $this->category;
    }

    /**
     * Set category.
     *
     * @param string $value
     *
     * @return Payload
     */
    public function setCategory(string $value): Payload
    {
        $this->category = $value;

        return $this;
    }

    /**
     * Get thread-id.
     *
     * @return string|null
     */
    public function getThreadId()
    {
        return $this->threadId;
    }

    /**
     * Set thread-id.
     *
     * @param string $value
     *
     * @return Payload
     */
    public function setThreadId(string $value): Payload
    {
        $this->threadId = $value;

        return $this;
    }

    /**
     * Get url-args.
     *
     * @return array|null
     */
    public function getUrlArgs()
    {
        return $this->urlArgs;
    }

    /**
     * Set url-args.
     *
     * @param array $value
     *
     * @return Payload
     */
    public function setUrlArgs(array $value): Payload
    {
        $this->urlArgs = $value;


        return $this;
    }

    /**
     * Set custom value for Payload.
     *
     * @param string $key
     * @param mixed $value
     *
     * @return Payload
     * @throws InvalidPayloadException
     */
    public function setCustomValue(string $key, $value): Payload
    {
        if ($key === self::PAYLOAD_ROOT_KEY) {
            throw InvalidPayloadException::reservedKey();
        }

        $this->customValues[$key] = $value;

        return $this;
    }

    /**
     * Get custom value.
     *
     * @param $key
     *
     * @return mixed
     * @throws InvalidPayloadException
     */
    public function getCustomValue($key)
    {
        if (!array_key_exists($key, $this->customValues)) {
            throw InvalidPayloadException::notExistingCustomValue($key);
        }

        return $this->customValues[$key];
    }

    /**
     * Set push type for Payload.
     *
     * @param string $pushType
     * @return Payload
     */
    public function setPushType($pushType) {
        $this->pushType = $pushType;

        return $this;
    }

    /**
     * Get push type for Payload.
     *
     * @return string
     */
    public function getPushType() {
        return $this->pushType;
    }

    /**
     * Convert Payload to JSON.
     *
     * @return string
     */
    public function toJson(): string
    {
        return json_encode($this, JSON_UNESCAPED_UNICODE);
    }

    /**
     * Specify data which should be serialized to JSON.
     *
     * @return array
     * @link   http://php.net/manual/en/jsonserializable.jsonserialize.php
     */
    public function jsonSerialize()
    {
        $payload = self::getDefaultPayloadStructure();

        if ($this->alert instanceof Alert || is_string($this->alert)) {
            $payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_ALERT_KEY} = $this->alert;
        }

        if (is_int($this->badge)) {
            $payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_BADGE_KEY} = $this->badge;
        }

        if (is_string($this->sound)) {
            $payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_SOUND_KEY} = $this->sound;
        }

        if (is_bool($this->contentAvailable)) {
            $payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_CONTENT_AVAILABLE_KEY} = (int)$this->contentAvailable;
        }

        if (is_bool($this->mutableContent)) {
            $payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_MUTABLE_CONTENT_KEY} = (int)$this->mutableContent;
        }

        if (is_string($this->category)) {
            $payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_CATEGORY_KEY} = $this->category;
        }

        if (is_string($this->threadId)) {
            $payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_THREAD_ID_KEY} = $this->threadId;
        }

        if (is_array($this->urlArgs)) {
            $payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_URL_ARGS_KEY} = $this->urlArgs;
        }

        if (is_countable($this->customValues) && count($this->customValues)) {
            $payload = array_merge($payload, $this->customValues);
        }

        return $payload;
    }

    /**
     * Get default payload structure.
     *
     * @return array
     */
    private static function getDefaultPayloadStructure()
    {
        return [self::PAYLOAD_ROOT_KEY => new \stdClass];
    }
}


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			use Countable;
15			use Pushok\Payload\Alert;
16
17			// Polyfill for PHP 7.2
18			if (!function_exists('is_countable')) {
19			function is_countable($var)
20			{
21			return (is_array($var) \|\| $var instanceof Countable);
22			}
23			}
24
25			/**
26			* Class Payload
27			*
28			* @package Pushok
29			*
30			* @see http://bit.ly/payload-key-reference
31			*/
32			class Payload implements \JsonSerializable
33			{
34			const PAYLOAD_ROOT_KEY = 'aps';
35			const PAYLOAD_ALERT_KEY = 'alert';
36			const PAYLOAD_BADGE_KEY = 'badge';
37			const PAYLOAD_SOUND_KEY = 'sound';
38			const PAYLOAD_CONTENT_AVAILABLE_KEY = 'content-available';
39			const PAYLOAD_MUTABLE_CONTENT_KEY = 'mutable-content';
40			const PAYLOAD_CATEGORY_KEY = 'category';
41			const PAYLOAD_THREAD_ID_KEY = 'thread-id';
42			const PAYLOAD_URL_ARGS_KEY = 'url-args';
43
44			const PAYLOAD_HTTP2_REGULAR_NOTIFICATION_MAXIMUM_SIZE = 4096;
45			const PAYLOAD_HTTP2_VOIP_NOTIFICATION_MAXIMUM_SIZE = 5120;
46			const PAYLOAD_BINARY_REGULAR_NOTIFICATION_MAXIMUM_SIZE = 2048;
47
48			/**
49			* The notification settings for your app on the user’s device determine whether an alert or banner is displayed.
50			*
51			* @var Alert\|string
52			*/
53			private $alert;
54
55			/**
56			* The number to display as the badge of the app icon.
57			* If this property is absent, the badge is not changed.
58			*
59			* @var int
60			*/
61			private $badge;
62
63			/**
64			* The name of a sound file in the app bundle or in the Library/Sounds folder of the app’s data container.
65			*
66			* @var string
67			*/
68			private $sound;
69
70			/**
71			* Include this key with a value of true to configure a silent notification.
72			*
73			* @var bool
74			*/
75			private $contentAvailable;
76
77			/**
78			* Include this key with a value of true to configure a mutable content notification.
79			*
80			* @var bool
81			*/
82			private $mutableContent;
83
84			/**
85			* Provide this key with a string value that represents the notification’s type.
86			*
87			* @var string
88			*/
89			private $category;
90
91			/**
92			* Provide this key with a string value that represents the app-specific identifier for grouping notifications.
93			*
94			* @var string
95			*/
96			private $threadId;
97
98			/**
99			* Provide this key with an array value that represents the url-args for Safari notifications.
100			*
101			* @var string
102			*/
103			private $urlArgs;
104
105			/**
106			* Payload custom values.
107			*
108			* @var array
109			*/
110			private $customValues;
111
112			/**
113			* Push notification type
114			*
115			* https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns#2947607
116			*
117			* @var string
118			*/
119			private $pushType;
120
121			protected function __construct()
122			{
123			}
124
125			/**
126			* @return Payload
127			*/
128			public static function create(): Payload
129			{
130			return new self();
131			}
132
133			/**
134			* Get Alert.
135			*
136			* @return Alert\|null
137			*/
138			public function getAlert()
139			{
140			return $this->alert;
141			}
142
143			/**
144			* Set Alert.
145			*
146			* @param Alert\|string $alert
147			*
148			* @return Payload
149			*/
150			public function setAlert($alert): Payload
151			{
152			if ($alert instanceof Alert \|\| is_string($alert)) {
153			$this->alert = $alert;
154			}
155
156			return $this;
157			}
158
159			/**
160			* Get badge.
161			*
162			* @return int\|null
163			*/
164			public function getBadge()
165			{
166			return $this->badge;
167			}
168
169			/**
170			* Set badge.
171			*
172			* @param int $value
173			*
174			* @return Payload
175			*/
176			public function setBadge(int $value): Payload
177			{
178			$this->badge = $value;
179
180			return $this;
181			}
182
183			/**
184			* Get sound.
185			*
186			* @return string\|null
187			*/
188			public function getSound()
189			{
190			return $this->sound;
191			}
192
193			/**
194			* Set sound.
195			*
196			* @param string $value
197			*
198			* @return Payload
199			*/
200			public function setSound(string $value): Payload
201			{
202			$this->sound = $value;
203
204			return $this;
205			}
206
207			/**
208			* Set content availability.
209			*
210			* @param bool $value
211			*
212			* @return Payload
213			*/
214			public function setContentAvailability(bool $value): Payload
215			{
216			$this->contentAvailable = $value;
217
218			return $this;
219			}
220
221			/**
222			* Get content availability.
223			*
224			* @return bool\|null
225			*/
226			public function isContentAvailable()
227			{
228			return $this->contentAvailable;
229			}
230
231			/**
232			* Set the mutable-content key for Notification Service Extensions on iOS10.
233			*
234			* @see http://bit.ly/mutable-content
235			*
236			* @param bool $value
237			*
238			* @return Payload
239			*/
240			public function setMutableContent(bool $value): Payload
241			{
242			$this->mutableContent = $value;
243
244			return $this;
245			}
246
247			/**
248			* Is content mutable.
249			*
250			* @return bool\|null
251			*/
252			public function hasMutableContent()
253			{
254			return $this->mutableContent;
255			}
256
257			/**
258			* Get category.
259			*
260			* @return string\|null
261			*/
262			public function getCategory()
263			{
264			return $this->category;
265			}
266
267			/**
268			* Set category.
269			*
270			* @param string $value
271			*
272			* @return Payload
273			*/
274			public function setCategory(string $value): Payload
275			{
276			$this->category = $value;
277
278			return $this;
279			}
280
281			/**
282			* Get thread-id.
283			*
284			* @return string\|null
285			*/
286			public function getThreadId()
287			{
288			return $this->threadId;
289			}
290
291			/**
292			* Set thread-id.
293			*
294			* @param string $value
295			*
296			* @return Payload
297			*/
298			public function setThreadId(string $value): Payload
299			{
300			$this->threadId = $value;
301
302			return $this;
303			}
304
305			/**
306			* Get url-args.
307			*
308			* @return array\|null
309			*/
310			public function getUrlArgs()
311			{
312			return $this->urlArgs;
313			}
314
315			/**
316			* Set url-args.
317			*
318			* @param array $value
319			*
320			* @return Payload
321			*/
322			public function setUrlArgs(array $value): Payload
323			{
324			$this->urlArgs = $value;
			0 ignored issues – show Documentation Bug introduced 2020-10-19 19:36 UTC by Report Bug Copy Issue Report It seems like `$value` of type `array` is incompatible with the declared type `string` of property `$urlArgs`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
325
326			return $this;
327			}
328
329			/**
330			* Set custom value for Payload.
331			*
332			* @param string $key
333			* @param mixed $value
334			*
335			* @return Payload
336			* @throws InvalidPayloadException
337			*/
338			public function setCustomValue(string $key, $value): Payload
339			{
340			if ($key === self::PAYLOAD_ROOT_KEY) {
341			throw InvalidPayloadException::reservedKey();
342			}
343
344			$this->customValues[$key] = $value;
345
346			return $this;
347			}
348
349			/**
350			* Get custom value.
351			*
352			* @param $key
353			*
354			* @return mixed
355			* @throws InvalidPayloadException
356			*/
357			public function getCustomValue($key)
358			{
359			if (!array_key_exists($key, $this->customValues)) {
360			throw InvalidPayloadException::notExistingCustomValue($key);
361			}
362
363			return $this->customValues[$key];
364			}
365
366			/**
367			* Set push type for Payload.
368			*
369			* @param string $pushType
370			* @return Payload
371			*/
372			public function setPushType($pushType) {
373			$this->pushType = $pushType;
374
375			return $this;
376			}
377
378			/**
379			* Get push type for Payload.
380			*
381			* @return string
382			*/
383			public function getPushType() {
384			return $this->pushType;
385			}
386
387			/**
388			* Convert Payload to JSON.
389			*
390			* @return string
391			*/
392			public function toJson(): string
393			{
394			return json_encode($this, JSON_UNESCAPED_UNICODE);
395			}
396
397			/**
398			* Specify data which should be serialized to JSON.
399			*
400			* @return array
401			* @link http://php.net/manual/en/jsonserializable.jsonserialize.php
402			*/
403			public function jsonSerialize()
404			{
405			$payload = self::getDefaultPayloadStructure();
406
407			if ($this->alert instanceof Alert \|\| is_string($this->alert)) {
408			$payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_ALERT_KEY} = $this->alert;
409			}
410
411			if (is_int($this->badge)) {
412			$payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_BADGE_KEY} = $this->badge;
413			}
414
415			if (is_string($this->sound)) {
416			$payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_SOUND_KEY} = $this->sound;
417			}
418
419			if (is_bool($this->contentAvailable)) {
420			$payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_CONTENT_AVAILABLE_KEY} = (int)$this->contentAvailable;
421			}
422
423			if (is_bool($this->mutableContent)) {
424			$payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_MUTABLE_CONTENT_KEY} = (int)$this->mutableContent;
425			}
426
427			if (is_string($this->category)) {
428			$payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_CATEGORY_KEY} = $this->category;
429			}
430
431			if (is_string($this->threadId)) {
432			$payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_THREAD_ID_KEY} = $this->threadId;
433			}
434
435			if (is_array($this->urlArgs)) {
436			$payload[self::PAYLOAD_ROOT_KEY]->{self::PAYLOAD_URL_ARGS_KEY} = $this->urlArgs;
437			}
438
439			if (is_countable($this->customValues) && count($this->customValues)) {
440			$payload = array_merge($payload, $this->customValues);
441			}
442
443			return $payload;
444			}
445
446			/**
447			* Get default payload structure.
448			*
449			* @return array
450			*/
451			private static function getDefaultPayloadStructure()
452			{
453			return [self::PAYLOAD_ROOT_KEY => new \stdClass];
454			}
455			}
456

edamov / pushok

Push — master ( b69afb...26655b )

Payload::getUrlArgs() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like