ApnMessage::contentAvailable() - Code Metrics - Inspection of "Updates (#24)" - laravel-notification-channels/apn - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e2ac31...2a478e )

by Barry vd.

created 2017-02-04 07:34 UTC

ApnMessage::contentAvailable() A

↳ Parent: ApnMessage

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
ccs	0
cts	3
cp	0
rs	9.4285
cc	1
eloc	3
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 = [];

    /**
     * @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
     *
     * @return static

     */
    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;
    }

    /**
     * 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,
        ]);
    }
}


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		* @param string\|null $title
58		* @param string\|null $body
59		* @param array $custom
60		* @param null\|int $badge
61		*
62		* @return static
63		*/
64		public static function create($title = null, $body = null, $custom = [], $badge = null)
65		{
66		return new static($title, $body, $custom, $badge);
67		}
68
69		/**
70		* @param string\|null $title
71		* @param string\|null $body
72		* @param array $custom
73		* @param null\|int $badge
74		*
75		* @return static
		0 ignored issues – show Comprehensibility Best Practice introduced 2016-09-24 12:53 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
76		*/
77	1	public function __construct($title = null, $body = null, $custom = [], $badge = null)
78		{
79	1	$this->title = $title;
80	1	$this->body = $body;
81	1	$this->custom = $custom;
82	1	$this->badge = $badge;
83	1	}
84
85		/**
86		* Set the alert title of the notification.
87		*
88		* @param string $title
89		*
90		* @return $this
91		*/
92		public function title($title)
93		{
94		$this->title = $title;
95
96		return $this;
97		}
98
99		/**
100		* Set the alert message of the notification.
101		*
102		* @param string $body
103		*
104		* @return $this
105		*/
106		public function body($body)
107		{
108		$this->body = $body;
109
110		return $this;
111		}
112
113		/**
114		* Set the badge of the notification.
115		*
116		* @param int $badge
117		*
118		* @return $this
119		*/
120		public function badge($badge)
121		{
122		$this->badge = $badge;
123
124		return $this;
125		}
126
127		/**
128		* Set the sound for the notification.
129		*
130		* @param string\|null $sound
131		*
132		* @return $this
133		*/
134		public function sound($sound = 'default')
135		{
136		$this->sound = $sound;
137
138		return $this;
139		}
140
141		/**
142		* Set category for this notification.
143		*
144		* @param string\|null $category
145		*
146		* @return $this
147		* */
148		public function category($category)
149		{
150		$this->category = $category;
151
152		return $this;
153		}
154
155		/**
156		* Set content available value for this notification.
157		*
158		* @param int $value
159		*
160		* @return $this
161		*/
162		public function contentAvailable($value = 1)
163		{
164		$this->contentAvailable = $value;
165
166		return $this;
167		}
168
169		/**
170		* Add custom data to the notification.
171		*
172		* @param string $key
173		* @param mixed $value
174		*
175		* @return $this
176		*/
177		public function custom($key, $value)
178		{
179		$this->custom[$key] = $value;
180
181		return $this;
182		}
183
184		/**
185		* Override the data of the notification.
186		*
187		* @param array $custom
188		*
189		* @return $this
190		*/
191		public function setCustom($custom)
192		{
193		$this->custom = $custom;
194
195		return $this;
196		}
197
198		/**
199		* Add an action to the notification.
200		*
201		* @param string $action
202		* @param mixed $params
203		*
204		* @return $this
205		*/
206		public function action($action, $params = null)
207		{
208		return $this->custom('action', [
209		'action' => $action,
210		'params' => $params,
211		]);
212		}
213		}
214

laravel-notification-channels / apn

GitHub Access Token became invalid

Push — master ( e2ac31...2a478e )

ApnMessage::contentAvailable() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like