These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | |||
3 | namespace Kunstmaan\SearchBundle\Configuration; |
||
4 | |||
5 | /** |
||
6 | * Interface for a SearchConfiguration |
||
7 | */ |
||
8 | interface SearchConfigurationInterface |
||
9 | { |
||
10 | /** |
||
11 | * Create indexes |
||
12 | */ |
||
13 | public function createIndex(); |
||
0 ignored issues
–
show
|
|||
14 | |||
15 | /** |
||
16 | * Populate the indexes |
||
17 | */ |
||
18 | public function populateIndex(); |
||
0 ignored issues
–
show
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
Loading history...
|
|||
19 | |||
20 | /** |
||
21 | * Delete indexes |
||
22 | */ |
||
23 | public function deleteIndex(); |
||
0 ignored issues
–
show
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
Loading history...
|
|||
24 | |||
25 | /** |
||
26 | * This method returns an array of languages that are not analyzed. |
||
27 | * |
||
28 | * @return array |
||
29 | */ |
||
30 | public function getLanguagesNotAnalyzed(); |
||
31 | } |
||
32 |
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.