ApnMessage::pushType() - Code Metrics - Inspection of "Support push type (#69)" - laravel-notification-channels/apn - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5ab28d...4ace99 )

by Dwight

created 2020-02-19 22:27 UTC

ApnMessage::pushType() A

↳ Parent: ApnMessage

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace NotificationChannels\Apn;

class ApnMessage
{
    /**
     * The title of the notification.
     *
     * @var string
     */
    public $title;

    /**
     * The body of the notification.
     *
     * @var string
     */
    public $body;

    /**
     * The badge of the notification.
     *
     * @var int
     */
    public $badge;

    /**
     * The sound for the notification.
     *
     * @var string|null
     */
    public $sound;

    /**
     * The category for action button.
     *
     * @var string|null
     * */
    public $category;

    /**
     * Value indicating incoming resource in the notification.
     *
     * @var int|null
     */
    public $contentAvailable = null;

    /**
     * Additional data of the notification.
     *
     * @var array
     */
    public $custom = [];

    /**
     * Value indicating when the message will expire.
     *
     * @var \string
     */
    public $pushType = null;

    /**
     * Message specific credentials.
     *
     * @var ApnCredentials
     */
    public $credentials = null;

    /**
     * The notification service app extension flag.
     *
     * @var int|null
     */
    public $mutableContent = null;

    /**
     * @param string|null $title
     * @param string|null $body
     * @param array $custom
     * @param null|int $badge
     *
     * @return static
     */
    public static function create($title = null, $body = null, $custom = [], $badge = null)
    {
        return new static($title, $body, $custom, $badge);
    }

    /**
     * @param string|null $title
     * @param string|null $body
     * @param array $custom
     * @param null|int $badge
     */
    public function __construct($title = null, $body = null, $custom = [], $badge = null)
    {
        $this->title = $title;
        $this->body = $body;
        $this->custom = $custom;
        $this->badge = $badge;
    }

    /**
     * Set the alert title of the notification.
     *
     * @param string $title
     *
     * @return $this
     */
    public function title($title)
    {
        $this->title = $title;

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

    /**
     * Set the sound for the notification.
     *
     * @param string|null $sound
     *
     * @return $this
     */
    public function sound($sound = 'default')
    {
        $this->sound = $sound;

        return $this;
    }

    /**
     * Set category for this notification.
     *
     * @param string|null $category
     *
     * @return $this
     * */
    public function category($category)
    {
        $this->category = $category;

        return $this;
    }

    /**
     * Set content available value for this notification.
     *
     * @param int $value
     *
     * @return $this
     */
    public function contentAvailable($value = 1)
    {
        $this->contentAvailable = $value;

        return $this;
    }

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

    }

    /**
     * Add custom data to the notification.
     *
     * @param string $key
     * @param mixed $value
     *
     * @return $this
     */
    public function custom($key, $value)
    {
        $this->custom[$key] = $value;

        return $this;
    }

    /**
     * Override the data of the notification.
     *
     * @param array $custom
     *
     * @return $this
     */
    public function setCustom($custom)
    {
        $this->custom = $custom;

        return $this;
    }

    /**
     * Add an action to the notification.
     *
     * @param string $action
     * @param mixed $params
     *
     * @return $this
     */
    public function action($action, $params = null)
    {
        return $this->custom('action', [
            'action' => $action,
            'params' => $params,
        ]);
    }

    /**
     * Set message specific credentials.
     *
     * @param \NotificationChannels\Apn\ApnCredentials $credentials
     * @return $this
     */
    public function credentials(ApnCredentials $credentials)
    {
        $this->credentials = $credentials;

        return $this;
    }

    /**
     * Set mutable content value for this notification.
     *
     * @param int $value
     *
     * @return $this
     */
    public function mutableContent($value = 1)
    {
        $this->mutableContent = $value;

        return $this;
    }
}


1		<?php
2
3		namespace NotificationChannels\Apn;
4
5		class ApnMessage
6		{
7		/**
8		* The title of the notification.
9		*
10		* @var string
11		*/
12		public $title;
13
14		/**
15		* The body of the notification.
16		*
17		* @var string
18		*/
19		public $body;
20
21		/**
22		* The badge of the notification.
23		*
24		* @var int
25		*/
26		public $badge;
27
28		/**
29		* The sound for the notification.
30		*
31		* @var string\|null
32		*/
33		public $sound;
34
35		/**
36		* The category for action button.
37		*
38		* @var string\|null
39		* */
40		public $category;
41
42		/**
43		* Value indicating incoming resource in the notification.
44		*
45		* @var int\|null
46		*/
47		public $contentAvailable = null;
48
49		/**
50		* Additional data of the notification.
51		*
52		* @var array
53		*/
54		public $custom = [];
55
56		/**
57		* Value indicating when the message will expire.
58		*
59		* @var \string
60		*/
61		public $pushType = null;
62
63		/**
64		* Message specific credentials.
65		*
66		* @var ApnCredentials
67		*/
68		public $credentials = null;
69
70		/**
71		* The notification service app extension flag.
72		*
73		* @var int\|null
74		*/
75		public $mutableContent = null;
76
77		/**
78	1	* @param string\|null $title
79		* @param string\|null $body
80	1	* @param array $custom
81		* @param null\|int $badge
82		*
83		* @return static
84		*/
85		public static function create($title = null, $body = null, $custom = [], $badge = null)
86		{
87		return new static($title, $body, $custom, $badge);
88		}
89	13
90		/**
91	13	* @param string\|null $title
92	13	* @param string\|null $body
93	13	* @param array $custom
94	13	* @param null\|int $badge
95	13	*/
96		public function __construct($title = null, $body = null, $custom = [], $badge = null)
97		{
98		$this->title = $title;
99		$this->body = $body;
100		$this->custom = $custom;
101		$this->badge = $badge;
102		}
103
104	1	/**
105		* Set the alert title of the notification.
106	1	*
107		* @param string $title
108	1	*
109		* @return $this
110		*/
111		public function title($title)
112		{
113		$this->title = $title;
114
115		return $this;
116		}
117
118	1	/**
119		* Set the alert message of the notification.
120	1	*
121		* @param string $body
122	1	*
123		* @return $this
124		*/
125		public function body($body)
126		{
127		$this->body = $body;
128
129		return $this;
130		}
131
132	1	/**
133		* Set the badge of the notification.
134	1	*
135		* @param int $badge
136	1	*
137		* @return $this
138		*/
139		public function badge($badge)
140		{
141		$this->badge = $badge;
142
143		return $this;
144		}
145
146	2	/**
147		* Set the sound for the notification.
148	2	*
149		* @param string\|null $sound
150	2	*
151		* @return $this
152		*/
153		public function sound($sound = 'default')
154		{
155		$this->sound = $sound;
156
157		return $this;
158		}
159
160	1	/**
161		* Set category for this notification.
162	1	*
163		* @param string\|null $category
164	1	*
165		* @return $this
166		* */
167		public function category($category)
168		{
169		$this->category = $category;
170
171		return $this;
172		}
173
174	1	/**
175		* Set content available value for this notification.
176	1	*
177		* @param int $value
178	1	*
179		* @return $this
180		*/
181		public function contentAvailable($value = 1)
182		{
183		$this->contentAvailable = $value;
184
185		return $this;
186		}
187
188		/**
189	2	* Set the push type for this notification.
190		*
191	2	* @param string $pushType
192		*
193	2	* @return $this
194		*/
195		public function pushType(string $pushType)
196		{
197		$this->pushType = $pushType;
		0 ignored issues – show Documentation Bug introduced 2020-02-19 22:36 UTC by Report Bug Copy Issue Report It seems like `$pushType` of type `string` is incompatible with the declared type `object<string>` of property `$pushType`. 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...
198		}
199
200		/**
201		* Add custom data to the notification.
202		*
203	1	* @param string $key
204		* @param mixed $value
205	1	*
206		* @return $this
207	1	*/
208		public function custom($key, $value)
209		{
210		$this->custom[$key] = $value;
211
212		return $this;
213		}
214
215		/**
216		* Override the data of the notification.
217		*
218	1	* @param array $custom
219		*
220	1	* @return $this
221	1	*/
222	1	public function setCustom($custom)
223		{
224		$this->custom = $custom;
225
226		return $this;
227		}
228
229		/**
230		* Add an action to the notification.
231		*
232		* @param string $action
233		* @param mixed $params
234		*
235		* @return $this
236		*/
237		public function action($action, $params = null)
238		{
239		return $this->custom('action', [
240		'action' => $action,
241		'params' => $params,
242		]);
243		}
244
245		/**
246	1	* Set message specific credentials.
247		*
248	1	* @param \NotificationChannels\Apn\ApnCredentials $credentials
249		* @return $this
250	1	*/
251		public function credentials(ApnCredentials $credentials)
252		{
253		$this->credentials = $credentials;
254
255		return $this;
256		}
257
258		/**
259		* Set mutable content value for this notification.
260		*
261		* @param int $value
262		*
263		* @return $this
264		*/
265		public function mutableContent($value = 1)
266		{
267		$this->mutableContent = $value;
268
269		return $this;
270		}
271		}
272

laravel-notification-channels / apn

GitHub Access Token became invalid

Push — master ( 5ab28d...4ace99 )

ApnMessage::pushType() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like