1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/* |
4
|
|
|
* This file is part of the Tinyissue package. |
5
|
|
|
* |
6
|
|
|
* (c) Mohamed Alsharaf <[email protected]> |
7
|
|
|
* |
8
|
|
|
* For the full copyright and license information, please view the LICENSE |
9
|
|
|
* file that was distributed with this source code. |
10
|
|
|
*/ |
11
|
|
|
|
12
|
|
|
namespace Tinyissue\Http\Controllers\Project; |
13
|
|
|
|
14
|
|
|
use Illuminate\Http\Request; |
15
|
|
|
use Illuminate\Http\Response; |
16
|
|
|
use Tinyissue\Form\Comment as CommentForm; |
17
|
|
|
use Tinyissue\Form\Issue as IssueForm; |
18
|
|
|
use Tinyissue\Http\Controllers\Controller; |
19
|
|
|
use Tinyissue\Http\Requests\FormRequest; |
20
|
|
|
use Tinyissue\Model\Project; |
21
|
|
|
use Tinyissue\Model\Project\Issue; |
22
|
|
|
use Tinyissue\Model\Project\Issue\Attachment; |
23
|
|
|
use Tinyissue\Model\Project\Issue\Comment; |
24
|
|
|
use Tinyissue\Model\Tag; |
25
|
|
|
use Tinyissue\Model\User\Activity as UserActivity; |
26
|
|
|
|
27
|
|
|
/** |
28
|
|
|
* IssueController is the controller class for managing request related to projects issues. |
29
|
|
|
* |
30
|
|
|
* @author Mohamed Alsharaf <[email protected]> |
31
|
|
|
*/ |
32
|
|
|
class IssueController extends Controller |
33
|
|
|
{ |
34
|
|
|
/** |
35
|
|
|
* Project issue index page (List project issues). |
36
|
|
|
* |
37
|
|
|
* @param Project $project |
38
|
|
|
* @param Issue $issue |
39
|
|
|
* @param CommentForm $form |
40
|
|
|
* |
41
|
|
|
* @return \Illuminate\View\View |
42
|
|
|
*/ |
43
|
16 |
|
public function getIndex(Project $project, Issue $issue, CommentForm $form) |
44
|
|
|
{ |
45
|
|
|
// Projects should be limited to issue-modify |
46
|
16 |
|
$projects = null; |
47
|
16 |
|
if (!$this->auth->guest() && $this->auth->user()->permission('issue-modify')) { |
|
|
|
|
48
|
13 |
|
$projects = $this->auth->user()->projects()->get(); |
|
|
|
|
49
|
|
|
} |
50
|
|
|
|
51
|
16 |
|
return view('project.issue.index', [ |
|
|
|
|
52
|
16 |
|
'issue' => $issue, |
53
|
16 |
|
'project' => $project, |
54
|
16 |
|
'commentForm' => $form, |
55
|
16 |
|
'sidebar' => 'project', |
56
|
16 |
|
'projects' => $projects, |
57
|
|
|
]); |
58
|
|
|
} |
59
|
|
|
|
60
|
|
|
/** |
61
|
|
|
* Ajax: Assign new user to an issue. |
62
|
|
|
* |
63
|
|
|
* @param Issue $issue |
64
|
|
|
* @param Request $request |
65
|
|
|
* |
66
|
|
|
* @return \Symfony\Component\HttpFoundation\Response |
67
|
|
|
*/ |
68
|
1 |
|
public function postAssign(Issue $issue, Request $request) |
69
|
|
|
{ |
70
|
1 |
|
$response = ['status' => false]; |
71
|
1 |
|
if ($issue->reassign((int) $request->input('user_id'), $this->auth->user())) { |
|
|
|
|
72
|
1 |
|
$response['status'] = true; |
73
|
|
|
} |
74
|
|
|
|
75
|
1 |
|
return response()->json($response); |
76
|
|
|
} |
77
|
|
|
|
78
|
|
|
/** |
79
|
|
|
* Ajax: save comment. |
80
|
|
|
* |
81
|
|
|
* @param Comment $comment |
82
|
|
|
* @param Request $request |
83
|
|
|
* |
84
|
|
|
* @return \Symfony\Component\HttpFoundation\Response |
85
|
|
|
*/ |
86
|
1 |
|
public function postEditComment(Comment $comment, Request $request) |
87
|
|
|
{ |
88
|
1 |
|
$body = ''; |
89
|
1 |
|
if ($request->has('body')) { |
90
|
1 |
|
$comment->updateBody($request->input('body'), $this->auth->user()); |
|
|
|
|
91
|
1 |
|
$body = \Html::format($comment->comment); |
92
|
|
|
} |
93
|
|
|
|
94
|
1 |
|
return response()->json(['text' => $body]); |
95
|
|
|
} |
96
|
|
|
|
97
|
|
|
/** |
98
|
|
|
* To add new comment to an issue. |
99
|
|
|
* |
100
|
|
|
* @param Project $project |
101
|
|
|
* @param Issue $issue |
102
|
|
|
* @param Comment $comment |
103
|
|
|
* @param FormRequest\Comment $request |
104
|
|
|
* |
105
|
|
|
* @return \Illuminate\Http\RedirectResponse |
106
|
|
|
*/ |
107
|
4 |
|
public function getAddComment(Project $project, Issue $issue, Comment $comment, FormRequest\Comment $request) |
108
|
|
|
{ |
109
|
4 |
|
$comment->setRelation('project', $project); |
110
|
4 |
|
$comment->setRelation('issue', $issue); |
111
|
4 |
|
$comment->setRelation('user', $this->auth->user()); |
112
|
4 |
|
$comment->createComment($request->all()); |
113
|
|
|
|
114
|
4 |
|
return redirect($issue->to() . '#comment' . $comment->id) |
115
|
4 |
|
->with('notice', trans('tinyissue.your_comment_added')); |
116
|
|
|
} |
117
|
|
|
|
118
|
|
|
/** |
119
|
|
|
* Ajax: to delete a comment. |
120
|
|
|
* |
121
|
|
|
* @param Comment $comment |
122
|
|
|
* |
123
|
|
|
* @return \Symfony\Component\HttpFoundation\Response |
124
|
|
|
*/ |
125
|
1 |
|
public function getDeleteComment(Comment $comment) |
126
|
|
|
{ |
127
|
1 |
|
$comment->deleteComment($this->auth->user()); |
|
|
|
|
128
|
|
|
|
129
|
1 |
|
return response()->json(['status' => true]); |
130
|
|
|
} |
131
|
|
|
|
132
|
|
|
/** |
133
|
|
|
* New issue form. |
134
|
|
|
* |
135
|
|
|
* @param Project $project |
136
|
|
|
* @param IssueForm $form |
137
|
|
|
* |
138
|
|
|
* @return \Illuminate\View\View |
139
|
|
|
*/ |
140
|
5 |
|
public function getNew(Project $project, IssueForm $form) |
141
|
|
|
{ |
142
|
5 |
|
return view('project.issue.new', [ |
|
|
|
|
143
|
5 |
|
'project' => $project, |
144
|
5 |
|
'form' => $form, |
145
|
5 |
|
'sidebar' => 'project', |
146
|
|
|
]); |
147
|
|
|
} |
148
|
|
|
|
149
|
|
|
/** |
150
|
|
|
* To create a new issue. |
151
|
|
|
* |
152
|
|
|
* @param Project $project |
153
|
|
|
* @param Issue $issue |
154
|
|
|
* @param FormRequest\Issue $request |
155
|
|
|
* |
156
|
|
|
* @return \Illuminate\Http\RedirectResponse |
157
|
|
|
*/ |
158
|
2 |
|
public function postNew(Project $project, Issue $issue, FormRequest\Issue $request) |
159
|
|
|
{ |
160
|
2 |
|
$issue->setRelation('project', $project); |
161
|
2 |
|
$issue->setRelation('user', $this->auth->user()); |
162
|
2 |
|
$issue->createIssue($request->all()); |
163
|
|
|
|
164
|
2 |
|
return redirect($issue->to()) |
165
|
2 |
|
->with('notice', trans('tinyissue.issue_has_been_created')); |
166
|
|
|
} |
167
|
|
|
|
168
|
|
|
/** |
169
|
|
|
* Edit an existing issue form. |
170
|
|
|
* |
171
|
|
|
* @param Project $project |
172
|
|
|
* @param Issue $issue |
173
|
|
|
* @param IssueForm $form |
174
|
|
|
* |
175
|
|
|
* @return \Illuminate\View\View |
176
|
|
|
*/ |
177
|
2 |
|
public function getEdit(Project $project, Issue $issue, IssueForm $form) |
178
|
|
|
{ |
179
|
|
|
// Cannot edit closed issue |
180
|
2 |
|
if ($issue->status == Issue::STATUS_CLOSED) { |
181
|
1 |
|
return redirect($issue->to()) |
|
|
|
|
182
|
1 |
|
->with('notice', trans('tinyissue.cant_edit_closed_issue')); |
183
|
|
|
} |
184
|
|
|
|
185
|
2 |
|
return view('project.issue.edit', [ |
|
|
|
|
186
|
2 |
|
'issue' => $issue, |
187
|
2 |
|
'project' => $project, |
188
|
2 |
|
'form' => $form, |
189
|
2 |
|
'sidebar' => 'project', |
190
|
|
|
]); |
191
|
|
|
} |
192
|
|
|
|
193
|
|
|
/** |
194
|
|
|
* To update an existing issue details. |
195
|
|
|
* |
196
|
|
|
* @param Project $project |
197
|
|
|
* @param Issue $issue |
198
|
|
|
* @param FormRequest\Issue $request |
199
|
|
|
* |
200
|
|
|
* @return \Illuminate\Http\RedirectResponse |
201
|
|
|
*/ |
202
|
1 |
|
public function postEdit(Project $project, Issue $issue, FormRequest\Issue $request) |
203
|
|
|
{ |
204
|
|
|
// Delete the issue |
205
|
1 |
|
if ($request->has('delete-issue')) { |
206
|
|
|
$issue->delete(); |
207
|
|
|
|
208
|
|
|
return redirect($project->to()) |
209
|
|
|
->with('notice', trans('tinyissue.issue_has_been_deleted')); |
210
|
|
|
} |
211
|
|
|
|
212
|
1 |
|
$issue->setRelation('project', $project); |
213
|
1 |
|
$issue->setRelation('updatedBy', $this->auth->user()); |
214
|
1 |
|
$issue->updateIssue($request->all()); |
215
|
|
|
|
216
|
1 |
|
return redirect($issue->to()) |
217
|
1 |
|
->with('notice', trans('tinyissue.issue_has_been_updated')); |
218
|
|
|
} |
219
|
|
|
|
220
|
|
|
/** |
221
|
|
|
* To close or reopen an issue. |
222
|
|
|
* |
223
|
|
|
* @param Project $project |
224
|
|
|
* @param Issue $issue |
225
|
|
|
* @param int $status |
226
|
|
|
* |
227
|
|
|
* @return \Illuminate\Http\RedirectResponse |
228
|
|
|
*/ |
229
|
2 |
|
public function getClose(Project $project, Issue $issue, $status = 0) |
230
|
|
|
{ |
231
|
2 |
|
if ($status == 0) { |
232
|
2 |
|
$message = trans('tinyissue.issue_has_been_closed'); |
233
|
|
|
} else { |
234
|
1 |
|
$message = trans('tinyissue.issue_has_been_reopened'); |
235
|
|
|
} |
236
|
|
|
|
237
|
2 |
|
$issue->setRelation('project', $project); |
238
|
2 |
|
$issue->changeStatus($status, $this->auth->user()); |
|
|
|
|
239
|
|
|
|
240
|
2 |
|
return redirect($issue->to()) |
241
|
2 |
|
->with('notice', $message); |
242
|
|
|
} |
243
|
|
|
|
244
|
|
|
/** |
245
|
|
|
* To upload an attachment file. |
246
|
|
|
* |
247
|
|
|
* @param Project $project |
248
|
|
|
* @param Attachment $attachment |
249
|
|
|
* @param Request $request |
250
|
|
|
* |
251
|
|
|
* @return \Symfony\Component\HttpFoundation\Response |
252
|
|
|
*/ |
253
|
3 |
|
public function postUploadAttachment(Project $project, Attachment $attachment, Request $request) |
254
|
|
|
{ |
255
|
|
|
try { |
256
|
3 |
|
if (!$this->auth->user()->permission('project-all')) { |
|
|
|
|
257
|
|
|
abort(404); |
258
|
|
|
} |
259
|
|
|
|
260
|
3 |
|
$attachment->upload($request->all(), $project, $this->auth->user()); |
|
|
|
|
261
|
|
|
|
262
|
|
|
$response = [ |
263
|
|
|
'upload' => [ |
264
|
|
|
[ |
265
|
3 |
|
'name' => $attachment->filename, |
266
|
3 |
|
'size' => $attachment->filesize, |
267
|
3 |
|
'fileId' => $attachment->id, |
268
|
|
|
], |
269
|
|
|
], |
270
|
|
|
]; |
271
|
|
|
} catch (\Exception $exception) { |
272
|
|
|
$file = $request->file('upload'); |
273
|
|
|
|
274
|
|
|
$response = [ |
275
|
|
|
'status' => false, |
276
|
|
|
'name' => $file->getClientOriginalName(), |
277
|
|
|
'error' => $exception->getMessage(), |
278
|
|
|
'trace' => $exception->getTraceAsString(), |
279
|
|
|
]; |
280
|
|
|
} |
281
|
|
|
|
282
|
3 |
|
return response()->json($response); |
283
|
|
|
} |
284
|
|
|
|
285
|
|
|
/** |
286
|
|
|
* Ajax: to remove an attachment file. |
287
|
|
|
* |
288
|
|
|
* @param Project $project |
289
|
|
|
* @param Attachment $attachment |
290
|
|
|
* @param Request $request |
291
|
|
|
* |
292
|
|
|
* @return \Symfony\Component\HttpFoundation\Response |
293
|
|
|
*/ |
294
|
1 |
|
public function postRemoveAttachment(Project $project, Attachment $attachment, Request $request) |
295
|
|
|
{ |
296
|
1 |
|
$attachment->remove($request->all(), $project, $this->auth->user()); |
|
|
|
|
297
|
|
|
|
298
|
1 |
|
return response()->json(['status' => true]); |
299
|
|
|
} |
300
|
|
|
|
301
|
|
|
/** |
302
|
|
|
* Delete attachment. |
303
|
|
|
* |
304
|
|
|
* @param Project $project |
305
|
|
|
* @param Issue $issue |
306
|
|
|
* @param Attachment $attachment |
307
|
|
|
* |
308
|
|
|
* @return \Illuminate\Http\RedirectResponse |
309
|
|
|
*/ |
310
|
|
|
public function getDeleteAttachment(Project $project, Issue $issue, Attachment $attachment) |
311
|
|
|
{ |
312
|
|
|
$path = config('filesystems.disks.local.root') |
313
|
|
|
. '/' . config('tinyissue.uploads_dir') |
314
|
|
|
. '/' . $project->id |
315
|
|
|
. '/' . $attachment->upload_token; |
316
|
|
|
try { |
317
|
|
|
$attachment->deleteFile($path, $attachment->filename); |
318
|
|
|
} catch (\Exception $e) { |
|
|
|
|
319
|
|
|
} |
320
|
|
|
$attachment->delete(); |
321
|
|
|
|
322
|
|
|
return redirect($issue->to()) |
323
|
|
|
->with('notice', trans('tinyissue.attachment_has_been_deleted')); |
324
|
|
|
} |
325
|
|
|
|
326
|
|
|
/** |
327
|
|
|
* Display an attachment file such as image. |
328
|
|
|
* |
329
|
|
|
* @param Project $project |
330
|
|
|
* @param Issue $issue |
331
|
|
|
* @param Attachment $attachment |
332
|
|
|
* @param Request $request |
333
|
|
|
* |
334
|
|
|
* @return Response |
335
|
|
|
*/ |
336
|
2 |
|
public function getDisplayAttachment(Project $project, Issue $issue, Attachment $attachment, Request $request) |
337
|
|
|
{ |
338
|
2 |
|
$issue->setRelation('project', $project); |
339
|
2 |
|
$attachment->setRelation('issue', $issue); |
340
|
|
|
|
341
|
2 |
|
$path = config('tinyissue.uploads_dir') . '/' . $issue->project_id . '/' . $attachment->upload_token . '/' . $attachment->filename; |
342
|
2 |
|
$storage = \Storage::disk('local'); |
343
|
2 |
|
$length = $storage->size($path); |
344
|
2 |
|
$time = $storage->lastModified($path); |
345
|
2 |
|
$type = $storage->getDriver()->getMimetype($path); |
346
|
|
|
|
347
|
2 |
|
$response = new Response(); |
348
|
2 |
|
$response->setEtag(md5($time . $path)); |
349
|
2 |
|
$response->setExpires(new \DateTime('@' . ($time + 60))); |
350
|
2 |
|
$response->setLastModified(new \DateTime('@' . $time)); |
351
|
2 |
|
$response->setPublic(); |
352
|
2 |
|
$response->setStatusCode(200); |
353
|
|
|
|
354
|
2 |
|
$response->header('Content-Type', $type); |
355
|
2 |
|
$response->header('Content-Length', $length); |
356
|
2 |
|
$response->header('Content-Disposition', 'inline; filename="' . $attachment->filename . '"'); |
357
|
2 |
|
$response->header('Cache-Control', 'must-revalidate'); |
358
|
|
|
|
359
|
2 |
|
if ($response->isNotModified($request)) { |
360
|
|
|
// Return empty response if not modified |
361
|
|
|
return $response; |
362
|
|
|
} |
363
|
|
|
|
364
|
|
|
// Return file if first request / modified |
365
|
2 |
|
$response->setContent($storage->get($path)); |
366
|
|
|
|
367
|
2 |
|
return $response; |
368
|
|
|
} |
369
|
|
|
|
370
|
|
|
/** |
371
|
|
|
* Download an attachment file. |
372
|
|
|
* |
373
|
|
|
* @param Project $project |
374
|
|
|
* @param Issue $issue |
375
|
|
|
* @param Attachment $attachment |
376
|
|
|
* |
377
|
|
|
* @return \Symfony\Component\HttpFoundation\BinaryFileResponse |
378
|
|
|
*/ |
379
|
1 |
|
public function getDownloadAttachment(Project $project, Issue $issue, Attachment $attachment) |
380
|
|
|
{ |
381
|
1 |
|
$issue->setRelation('project', $project); |
382
|
1 |
|
$attachment->setRelation('issue', $issue); |
383
|
|
|
|
384
|
1 |
|
$path = config('filesystems.disks.local.root') . '/' . config('tinyissue.uploads_dir') . '/' . $issue->project_id . '/' . $attachment->upload_token . '/' . $attachment->filename; |
385
|
|
|
|
386
|
1 |
|
return response()->download($path, $attachment->filename); |
387
|
|
|
} |
388
|
|
|
|
389
|
|
|
/** |
390
|
|
|
* Ajax: move an issue to another project. |
391
|
|
|
* |
392
|
|
|
* @param Issue $issue |
393
|
|
|
* @param Request $request |
394
|
|
|
* |
395
|
|
|
* @return \Symfony\Component\HttpFoundation\Response |
396
|
|
|
*/ |
397
|
1 |
|
public function postChangeProject(Issue $issue, Request $request) |
398
|
|
|
{ |
399
|
1 |
|
$issue->changeProject($request->input('project_id')); |
|
|
|
|
400
|
|
|
|
401
|
1 |
|
return response()->json(['status' => true, 'url' => $issue->to()]); |
402
|
|
|
} |
403
|
|
|
|
404
|
|
|
/** |
405
|
|
|
* Ajax: change status of an issue. |
406
|
|
|
* |
407
|
|
|
* @param Issue $issue |
408
|
|
|
* @param Request $request |
409
|
|
|
* |
410
|
|
|
* @return \Symfony\Component\HttpFoundation\Response |
411
|
|
|
*/ |
412
|
|
|
public function postChangeKanbanTag(Issue $issue, Request $request) |
413
|
|
|
{ |
414
|
|
|
$newTag = Tag::find((int) $request->input('newtag')); |
415
|
|
|
$oldTag = Tag::find((int) $request->input('oldtag')); |
416
|
|
|
|
417
|
|
|
$issue->changeKanbanTag($newTag, $oldTag); |
418
|
|
|
|
419
|
|
|
return response()->json(['status' => true, 'issue' => $issue->id]); |
420
|
|
|
} |
421
|
|
|
|
422
|
|
|
/** |
423
|
|
|
* Ajax: returns comments for an issue. |
424
|
|
|
* |
425
|
|
|
* @param Project $project |
426
|
|
|
* @param Issue $issue |
427
|
|
|
* |
428
|
|
|
* @return \Symfony\Component\HttpFoundation\Response |
429
|
|
|
*/ |
430
|
8 |
|
public function getIssueComments(Project $project, Issue $issue) |
431
|
|
|
{ |
432
|
|
|
$issue->attachments->each(function (Attachment $attachment) use ($issue) { |
|
|
|
|
433
|
|
|
$attachment->setRelation('issue', $issue); |
434
|
8 |
|
}); |
435
|
8 |
|
$activities = $issue->commentActivities()->with('activity', 'user', 'comment', 'assignTo', |
436
|
8 |
|
'comment.attachments')->get(); |
437
|
|
|
$activities->each(function (UserActivity $activity) use ($issue) { |
438
|
8 |
|
$activity->setRelation('issue', $issue); |
439
|
8 |
|
}); |
440
|
|
|
|
441
|
|
View Code Duplication |
$activityString = $activities->map(function (UserActivity $activity) use ($project, $issue) { |
|
|
|
|
442
|
8 |
|
return view('project/issue/activity/' . $activity->activity->activity, [ |
|
|
|
|
443
|
8 |
|
'issue' => $issue, |
444
|
8 |
|
'userActivity' => $activity, |
445
|
8 |
|
'project' => $project, |
446
|
8 |
|
'user' => $activity->user, |
|
|
|
|
447
|
8 |
|
'comment' => $activity->comment, |
|
|
|
|
448
|
8 |
|
'assigned' => $activity->assignTo, |
|
|
|
|
449
|
8 |
|
])->render(); |
450
|
8 |
|
})->implode(''); |
451
|
|
|
|
452
|
8 |
|
if (empty($activityString)) { |
453
|
|
|
$activityString = '<li class="no-records">There are no comments yet on this issue.</li>'; |
454
|
|
|
} |
455
|
|
|
|
456
|
8 |
|
return response()->json(['status' => true, 'activity' => $activityString]); |
457
|
|
|
} |
458
|
|
|
|
459
|
|
|
/** |
460
|
|
|
* Ajax: returns activities for an issue excluding comments. |
461
|
|
|
* |
462
|
|
|
* @param Project $project |
463
|
|
|
* @param Issue $issue |
464
|
|
|
* |
465
|
|
|
* @return \Symfony\Component\HttpFoundation\Response |
466
|
|
|
*/ |
467
|
1 |
|
public function getIssueActivity(Project $project, Issue $issue) |
468
|
|
|
{ |
469
|
1 |
|
$activities = $issue->generalActivities()->with('activity', 'user', 'assignTo')->get(); |
470
|
|
|
$activities->each(function (UserActivity $activity) use ($issue) { |
471
|
1 |
|
$activity->setRelation('issue', $issue); |
472
|
1 |
|
}); |
473
|
|
|
|
474
|
1 |
View Code Duplication |
$activityString = $activities->map(function (UserActivity $activity) use ($project, $issue) { |
|
|
|
|
475
|
1 |
|
return view('project/issue/activity/' . $activity->activity->activity, [ |
|
|
|
|
476
|
1 |
|
'issue' => $issue, |
477
|
1 |
|
'userActivity' => $activity, |
478
|
1 |
|
'activity' => $activity, |
479
|
1 |
|
'project' => $project, |
480
|
1 |
|
'user' => $activity->user, |
|
|
|
|
481
|
1 |
|
'comment' => $activity->comment, |
|
|
|
|
482
|
1 |
|
'assigned' => $activity->assignTo, |
|
|
|
|
483
|
1 |
|
])->render(); |
484
|
1 |
|
})->implode(''); |
485
|
|
|
|
486
|
1 |
|
if (empty($activityString)) { |
487
|
|
|
$activityString = '<li class="no-records">There are no activity yet on this issue.</li>'; |
488
|
|
|
} |
489
|
|
|
|
490
|
1 |
|
return response()->json(['status' => true, 'activity' => $activityString]); |
491
|
|
|
} |
492
|
|
|
} |
493
|
|
|
|
Let’s take a look at an example:
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.
Available Fixes
Change the type-hint for the parameter:
Add an additional type-check:
Add the method to the interface: