aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/Wallabag/CoreBundle/Entity/Notification.php
blob: d4304f39f13279561dbb994d683c8cd06f4f304d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
<?php

namespace Wallabag\CoreBundle\Entity;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Wallabag\CoreBundle\Notifications\ActionInterface;
use Wallabag\CoreBundle\Notifications\NotificationInterface;
use Wallabag\UserBundle\Entity\User;

/**
 * Class Notification.
 * Class Notification
 *
 * @ORM\Entity(repositoryClass="Wallabag\CoreBundle\Repository\NotificationRepository")
 * @ORM\Table(name="`notification`")
 */
class Notification implements NotificationInterface
{
    /**
     * @var int
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     *
     */
    protected $id;

    /**
     * @var int $type
     *
     * @ORM\Column(name="type", type="integer")
     */
    protected $type;

    /**
     * @var User $user
     *
     * @ORM\ManyToOne(targetEntity="Wallabag\UserBundle\Entity\User", inversedBy="notifications")
     */
    protected $user;

    /**
     *
     * @ORM\Column(name="timestamp", type="datetime")
     */
    protected $timestamp;

    /**
     * @var string $title
     *
     * @ORM\Column(name="title", type="string")
     */
    protected $title;

    /**
     * @var string
     *
     * @ORM\Column(name="description", type="string", nullable=true)
     */
    protected $description;

    /**
     * @var boolean $read
     *
     * @ORM\Column(name="read", type="boolean")
     */
    protected $read;

    /**
     * @var array
     *
     * @ORM\Column(name="parameters", type="array", nullable=true)
     */
    protected $parameters;

    protected $logger;

    /**
     * @var ArrayCollection<ActionInterface>
     *
     * @ORM\Column(name="actions", type="array", nullable=true)
     */
    protected $actions;

    protected $actionTypes = [];

    const TYPE_ADMIN = 0;
    const TYPE_USER = 1;
    const TYPE_RELEASE = 2;
    const TYPE_SHARE = 3;

    public function __construct(User $user = null)
    {
        $this->logger = new NullLogger();
        $this->timestamp = new \DateTime();
        $this->actions = new ArrayCollection();
        $this->parameters = [];
        $this->read = false;
        $this->user = $user;
    }

    /**
     * @param LoggerInterface $logger
     *
     * @return NotificationInterface
     */
    public function setLogger(LoggerInterface $logger)
    {
        $this->logger = $logger;

        return $this;
    }

    /**
     * @return mixed
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @return mixed
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @param mixed $type
     *
     * @return NotificationInterface
     */
    public function setType($type)
    {
        $this->type = $type;

        return $this;
    }

    /**
     * @return User
     */
    public function getUser()
    {
        return $this->user;
    }

    /**
     * @param User $user
     *
     * @return NotificationInterface
     */
    public function setUser(User $user)
    {
        $this->user = $user;

        return $this;
    }

    /**
     * @return \DateTime
     */
    public function getTimestamp()
    {
        return $this->timestamp;
    }

    /**
     * @param \DateTime $timestamp
     *
     * @return NotificationInterface
     */
    public function setTimestamp(\DateTime $timestamp)
    {
        $this->timestamp = $timestamp;

        return $this;
    }

    /**
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * @param string $title
     *
     * @return NotificationInterface
     */
    public function setTitle($title)
    {
        $this->title = $title;

        return $this;
    }

    /**
     * @return bool
     */
    public function isRead()
    {
        return $this->read;
    }

    /**
     * @param bool $read
     *
     * @return NotificationInterface
     */
    public function setRead($read)
    {
        $this->read = $read;

        return $this;
    }

    /**
     * @param ActionInterface $action
     *
     * @return NotificationInterface
     * @throws \InvalidArgumentException
     */
    public function addAction(ActionInterface $action)
    {
        if (isset($this->actionTypes[$action->getType()])) {
            throw new \InvalidArgumentException('The notification already has a primary action');
        }
        $this->actionTypes[$action->getType()] = true;
        $this->actions->add($action);
        return $this;
    }

    /**
     * @return ArrayCollection<ActionInterface>
     */
    public function getActions()
    {
        return $this->actions;
    }

    /**
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * @param string $description
     *
     * @return Notification
     */
    public function setDescription($description)
    {
        $this->description = $description;

        return $this;
    }

    /**
     * @return array
     */
    public function getParameters()
    {
        return $this->parameters;
    }

    /**
     * @param array $parameters
     *
     * @return Notification
     */
    public function setParameters($parameters)
    {
        $this->parameters = $parameters;

        return $this;
    }

    /**
     * @param string $key
     * @param string $value
     *
     * @return Notification
     *
     * @throws \InvalidArgumentException
     */
    public function addParameter($key, $value)
    {
        if (in_array($key, $this->parameters, true)) {
            throw new \InvalidArgumentException('This parameter already is set');
        }

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

        return $this;
    }
}