DeleteThreadManagerInterface::deleteThread()
last analyzed

Size

Total Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 1
c 0
b 0
f 0
1
<?php
2
3
/*
4
 * This file is part of the MilioooMessageBundle package.
5
 *
6
 * (c) Michiel boeckaert <[email protected]>
7
 * This source file is subject to the MIT license that is bundled
8
 * with this source code in the file LICENSE.
9
 */
10
11
namespace Miliooo\Messaging\Manager;
12
13
use Miliooo\Messaging\Model\ThreadInterface;
14
15
/**
16
 * The delete thread manager is responsible for deleting threads.
17
 *
18
 * @author Michiel Boeckaert <[email protected]>
19
 */
20
interface DeleteThreadManagerInterface
21
{
22
    /**
23
     * Deletes a thread.
24
     *
25
     * @param ThreadInterface $thread The thread we want to delete
26
     * @param boolean         $flush  Whether to flush, defaults to true
27
     */
28
    public function deleteThread(ThreadInterface $thread, $flush = true);
0 ignored issues
show
Documentation introduced by
For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a @return doc comment to communicate to implementors of these methods what they are expected to return.

Loading history...
29
}
30