Completed
Branch master (d73cff)
by ZuPago HyBrid
01:28
created

WebPushMessage   A

Complexity

Total Complexity 9

Size/Duplication

Total Lines 155
Duplicated Lines 0 %

Coupling/Cohesion

Components 2
Dependencies 0

Test Coverage

Coverage 0%

Importance

Changes 0
Metric Value
wmc 9
lcom 2
cbo 0
dl 0
loc 155
ccs 0
cts 49
cp 0
rs 10
c 0
b 0
f 0

9 Methods

Rating   Name   Duplication   Size   Complexity  
A create() 0 4 1
A __construct() 0 6 1
A id() 0 6 1
A title() 0 6 1
A badge() 0 6 1
A body() 0 6 1
A icon() 0 6 1
A action() 0 6 1
A toArray() 0 11 1
1
<?php
2
3
namespace NotificationChannels\WebPush;
4
5
class WebPushMessage
6
{
7
    /**
8
     * The notification id.
9
     *
10
     * @var string
11
     */
12
    protected $id = null;
13
14
    /**
15
     * The notification title.
16
     *
17
     * @var string
18
     */
19
    protected $title;
20
    protected $badge;
21
22
    /**
23
     * The notification body.
24
     *
25
     * @var string
26
     */
27
    protected $body;
28
29
    /**
30
     * The notification icon.
31
     *
32
     * @var string
33
     */
34
    protected $icon = null;
35
36
    /**
37
     * The notification actions.
38
     *
39
     * @var array
40
     */
41
    protected $actions = [];
42
43
    /**
44
     * @param string $body
45
     *
46
     * @return static
47
     */
48
    public static function create($body = '')
49
    {
50
        return new static($body);
51
    }
52
53
    /**
54
     * @param string $body
55
     */
56
    public function __construct($body = '')
57
    {
58
        $this->title = '';
59
60
        $this->body = $body;
61
    }
62
63
    /**
64
     * Set the notification id.
65
     *
66
     * @param  string $value
67
     * @return $this
68
     */
69
    public function id($value)
70
    {
71
        $this->id = $value;
72
73
        return $this;
74
    }
75
76
    /**
77
     * Set the notification title.
78
     *
79
     * @param  string $value
80
     * @return $this
81
     */
82
    public function title($value)
83
    {
84
        $this->title = $value;
85
86
        return $this;
87
    }
88
89
    public function badge($badge)
90
    {
91
        $this->title = $badge;
92
93
        return $this;
94
    }
95
96
    /**
97
     * Set the notification body.
98
     *
99
     * @param  string $value
100
     * @return $this
101
     */
102
    public function body($value)
103
    {
104
        $this->body = $value;
105
106
        return $this;
107
    }
108
109
    /**
110
     * Set the notification icon.
111
     *
112
     * @param  string $value
113
     * @return $this
114
     */
115
    public function icon($value)
116
    {
117
        $this->icon = $value;
118
119
        return $this;
120
    }
121
122
    /**
123
     * Set an action.
124
     *
125
     * @param  string $title
0 ignored issues
show
Bug introduced by
There is no parameter named $title. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
126
     * @param  string $action
0 ignored issues
show
Bug introduced by
There is no parameter named $action. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
127
     * @return $this
128
     */
129
    public function action($value)
130
    {
131
        $this->actions = $value;
132
133
        return $this;
134
    }
135
136
    // public function action($value)
0 ignored issues
show
Unused Code Comprehensibility introduced by
56% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
137
    //     {
138
    //         $this->action = $value;
0 ignored issues
show
Unused Code Comprehensibility introduced by
45% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
139
140
    //         return $this;
141
    //     }
142
143
    /**
144
     * Get an array representation of the message.
145
     *
146
     * @return array
147
     */
148
    public function toArray()
149
    {
150
        return [
151
            //'id' => $this->id,
0 ignored issues
show
Unused Code Comprehensibility introduced by
63% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
152
            'title' => $this->title,
153
            'body' => $this->body,
154
            'actions' => $this->actions,
155
            'badge' => $this->badge,
156
            'icon' => $this->icon,
157
        ];
158
    }
159
}
160