Completed
Push — master ( 6d6774...64f3ed )
by Jeroen
11:23 queued 05:13
created

SearchBundle/Search/AnalysisFactoryInterface.php (2 issues)

Upgrade to new PHP Analysis Engine

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\Search;
4
5
interface AnalysisFactoryInterface
6
{
7
    /**
8
     * @return array
9
     */
10
    public function build();
11
12
    /**
13
     * @param string $language
14
     *
15
     * @return AnalysisFactoryInterface
16
     */
17
    public function addIndexAnalyzer($language);
18
19
    /**
20
     * @param string $language
21
     *
22
     * @return AnalysisFactoryInterface
23
     */
24
    public function addSuggestionAnalyzer($language);
25
26
    /**
27
     * @param string $language
28
     *
29
     * @return AnalysisFactoryInterface
30
     */
31
    public function addStopWordsFilter($language);
32
33
    /**
34
     * @param string $language
35
     *
36
     * @return AnalysisFactoryInterface
37
     */
38
    public function addStemmerFilter($language);
39
40
    /**
41
     * @return AnalysisFactoryInterface
42
     */
43
    public function addStripSpecialCharsFilter();
44
45
    /**
46
     * @return AnalysisFactoryInterface
47
     */
48
    public function addNGramTokenizer();
49
50
    /**
51
     * @param string $language
0 ignored issues
show
There is no parameter named $language. 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...
52
     */
53
    public function setupLanguage($lang = 'english');
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 @return doc comment to communicate to implementors of these methods what they are expected to return.

Loading history...
54
}
55