ExpoMessage::setChannelId() - Code Metrics - Inspection of "Accomodate to breaking change introduced in v27 fo..." - Alymosul/laravel-exponent-push-notifications - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 504a7e...883fbf )

by Aly

created 2018-07-25 13:49 UTC

ExpoMessage::setChannelId() A

↳ Parent: ExpoMessage

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
ccs	3
cts	3
cp	1
rs	10
cc	1
nc	1
nop	1
crap	1

<?php

namespace NotificationChannels\ExpoPushNotifications;

use NotificationChannels\ExpoPushNotifications\Exceptions\CouldNotCreateMessage;

class ExpoMessage
{
    /**
     * The message body.
     *
     * @var string
     */
    protected $body;

    /**
     * The sound to play when the recipient receives this notification.
     *
     * @var string|null
     */
    protected $sound = 'default';

    /**
     * The number to display next to the push notification (iOS).
     * Specify zero to clear the badge.
     *
     * @var int
     */
    protected $badge = 0;

    /**
     * The number of seconds for which the message may be kept around for redelivery if it has not been delivered yet.
     *
     * @var int
     */
    protected $ttl = 0;

    /**
     * ID of the Notification Channel through which to display this notification on Android devices.
     *
     * @var string
     */
    protected $channelId = "Default";

    /**
     * The json data attached to the message.
     *
     * @var string
     */
    protected $jsonData = '';

    /**
     * Create a message with given body.
     *
     * @param string $body
     *
     * @return static
     */
    public static function create($body = '')
    {
        return new static($body);
    }

    /**
     * ExpoMessage constructor.
     *
     * @param string $body
     */
    public function __construct(string $body = '')
    {
        $this->body = $body;
    }

    /**
     * Set the message body.
     *
     * @param string $value
     *
     * @return $this
     */
    public function body(string $value)
    {
        $this->body = $value;

        return $this;
    }

    /**
     * Enable the message sound.
     *
     * @return $this
     */
    public function enableSound()
    {
        $this->sound = 'default';

        return $this;
    }

    /**
     * Disable the message sound.
     *
     * @return $this
     */
    public function disableSound()
    {
        $this->sound = null;

        return $this;
    }

    /**
     * Set the message badge (iOS).
     *
     * @param int $value
     *
     * @return $this
     */
    public function badge(int $value)
    {
        $this->badge = $value;

        return $this;
    }

    /**
     * Set the time to live of the notification.
     *
     * @param int $ttl
     *
     * @return $this
     */
    public function setTtl(int $ttl)
    {
        $this->ttl = $ttl;

        return $this;
    }

    /**
     * Set the channelId of the notification for Android devices.
     *
     * @param string $channelId
     */
    public function setChannelId(string $channelId)
    {
        $this->channelId = $channelId;
    }

    /**
     * Set the json Data attached to the message.
     *
     * @param array|string $data
     *
     * @return $this
     *
     * @throws CouldNotCreateMessage
     */
    public function setJsonData($data)
    {
        if (is_array($data)) {
            $data = json_encode($data);
        } elseif (is_string($data)) {
            @json_decode($data);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

            if (json_last_error() !== JSON_ERROR_NONE) {
                throw new CouldNotCreateMessage('Invalid json format passed to the setJsonData().');
            }
        }

        $this->jsonData = $data;

        return $this;
    }

    /**
     * Get an array representation of the message.
     *
     * @return array
     */
    public function toArray()
    {
        return [
            'body'      =>  $this->body,
            'sound'     =>  $this->sound,
            'badge'     =>  $this->badge,
            'ttl'       =>  $this->ttl,
            'channelId' =>  $this->channelId,
            'data'      => $this->jsonData,
        ];
    }
}


1		<?php
2
3		namespace NotificationChannels\ExpoPushNotifications;
4
5		use NotificationChannels\ExpoPushNotifications\Exceptions\CouldNotCreateMessage;
6
7		class ExpoMessage
8		{
9		/**
10		* The message body.
11		*
12		* @var string
13		*/
14		protected $body;
15
16		/**
17		* The sound to play when the recipient receives this notification.
18		*
19		* @var string\|null
20		*/
21		protected $sound = 'default';
22
23		/**
24		* The number to display next to the push notification (iOS).
25		* Specify zero to clear the badge.
26		*
27		* @var int
28		*/
29		protected $badge = 0;
30
31		/**
32		* The number of seconds for which the message may be kept around for redelivery if it has not been delivered yet.
33		*
34		* @var int
35		*/
36		protected $ttl = 0;
37
38		/**
39		* ID of the Notification Channel through which to display this notification on Android devices.
40		*
41		* @var string
42		*/
43		protected $channelId = "Default";
44
45		/**
46		* The json data attached to the message.
47		*
48		* @var string
49		*/
50		protected $jsonData = '';
51
52		/**
53		* Create a message with given body.
54		*
55		* @param string $body
56		*
57		* @return static
58		*/
59	1	public static function create($body = '')
60		{
61	1	return new static($body);
62		}
63
64		/**
65		* ExpoMessage constructor.
66		*
67		* @param string $body
68		*/
69	11	public function __construct(string $body = '')
70		{
71	11	$this->body = $body;
72	11	}
73
74		/**
75		* Set the message body.
76		*
77		* @param string $value
78		*
79		* @return $this
80		*/
81	1	public function body(string $value)
82		{
83	1	$this->body = $value;
84
85	1	return $this;
86		}
87
88		/**
89		* Enable the message sound.
90		*
91		* @return $this
92		*/
93	1	public function enableSound()
94		{
95	1	$this->sound = 'default';
96
97	1	return $this;
98		}
99
100		/**
101		* Disable the message sound.
102		*
103		* @return $this
104		*/
105	2	public function disableSound()
106		{
107	2	$this->sound = null;
108
109	2	return $this;
110		}
111
112		/**
113		* Set the message badge (iOS).
114		*
115		* @param int $value
116		*
117		* @return $this
118		*/
119	1	public function badge(int $value)
120		{
121	1	$this->badge = $value;
122
123	1	return $this;
124		}
125
126		/**
127		* Set the time to live of the notification.
128		*
129		* @param int $ttl
130		*
131		* @return $this
132		*/
133	1	public function setTtl(int $ttl)
134		{
135	1	$this->ttl = $ttl;
136
137	1	return $this;
138		}
139
140		/**
141		* Set the channelId of the notification for Android devices.
142		*
143		* @param string $channelId
144		*/
145	1	public function setChannelId(string $channelId)
146		{
147	1	$this->channelId = $channelId;
148	1	}
149
150		/**
151		* Set the json Data attached to the message.
152		*
153		* @param array\|string $data
154		*
155		* @return $this
156		*
157		* @throws CouldNotCreateMessage
158		*/
159	1	public function setJsonData($data)
160		{
161	1	if (is_array($data)) {
162		$data = json_encode($data);
163	1	} elseif (is_string($data)) {
164	1	@json_decode($data);
		0 ignored issues – show Security Best Practice introduced 2018-07-04 10:54 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
165
166	1	if (json_last_error() !== JSON_ERROR_NONE) {
167		throw new CouldNotCreateMessage('Invalid json format passed to the setJsonData().');
168		}
169		}
170
171	1	$this->jsonData = $data;
172
173	1	return $this;
174		}
175
176		/**
177		* Get an array representation of the message.
178		*
179		* @return array
180		*/
181	11	public function toArray()
182		{
183		return [
184	11	'body' => $this->body,
185	11	'sound' => $this->sound,
186	11	'badge' => $this->badge,
187	11	'ttl' => $this->ttl,
188	11	'channelId' => $this->channelId,
189	11	'data' => $this->jsonData,
190		];
191		}
192		}
193

Alymosul / laravel-exponent-push-notifications

Push — master ( 504a7e...883fbf )

ExpoMessage::setChannelId() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like