PMF_Search_Elasticsearch::search() - Code Metrics - Inspection of "Added wrapper method for autocomplete (#1073)" - thorsten/phpMyFAQ - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.9 ( e1b57e...0e03d0 )

by Thorsten

created 2015-12-29 12:29 UTC

PMF_Search_Elasticsearch::search() B

↳ Parent: PMF_Search_Elasticsearch

Complexity

Conditions	4
Paths	4

Size

Total Lines	66
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	66
rs	8.8291
cc	4
eloc	40
nc	4
nop	1

How to fix Long Method

<?php

use Elasticsearch\Client;

/**
 * phpMyFAQ Elasticsearch based search classes.
 *
 * PHP Version 5.5
 *
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/.
 *
 * @category  phpMyFAQ
 * @author    Thorsten Rinne <[email protected]>
 * @copyright 2015 phpMyFAQ Team
 * @license   http://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
 * @link      http://www.phpmyfaq.de
 * @since     2015-12-25
 */
if (!defined('IS_VALID_PHPMYFAQ')) {
    exit();
}

/**
 * PMF_Search_Elasticsearch.
 *
 * @category  phpMyFAQ
 * @author    Thorsten Rinne <[email protected]>
 * @copyright 2015 phpMyFAQ Team
 * @license   http://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
 * @link      http://www.phpmyfaq.de
 * @since     2015-12-25
 */
class PMF_Search_Elasticsearch extends PMF_Search_Abstract implements PMF_Search_Interface
{
    /** @var Client */
    private $client = null;

    /** @var array */
    private $esConfig = [];

    /** @var string */
    private $language = '';

    /** @var array */
    private $categoryIds = [];

    /**
     * Constructor.
     *
     * @param PMF_Configuration
     */
    public function __construct(PMF_Configuration $config)
    {
        parent::__construct($config);

        $this->client = $this->_config->getElasticsearch();
        $this->esConfig = $this->_config->getElasticsearchConfig();
    }

    /**
     * Prepares the search and executes it.
     *
     * @param string $searchTerm Search term
     *
     * @throws PMF_Search_Exception
     *
     * @return array
     */
    public function search($searchTerm)
    {
        if ('' !== $this->getLanguage()) {
            $languageFilter = [
                'term' => [
                    'lang' => $this->getLanguage()
                ]
            ];
        } else {
            $languageFilter = '';
        }

        $searchParams = [
            'index' => $this->esConfig['index'],
            'type' => $this->esConfig['type'],
            'size' => 1000,
            'body' => [
                'query' => [
                    'filtered' => [
                        'filter' => [
                            'bool' => [
                                'must' => [
                                    [
                                        'terms' => [ 'category_id' => $this->getCategoryIds() ]
                                    ],
                                    $languageFilter
                                ]
                            ]
                        ],
                        'query' => [
                            'bool' => [
                                'should' => [
                                    [ 'match' => [ 'question' => $searchTerm ] ],
                                    [ 'match' => [ 'answer' => $searchTerm ] ],
                                    [ 'match' => [ 'keywords' => $searchTerm ] ]
                                ]
                            ]
                        ]
                    ]
                ]
            ]
        ];

        $result = $this->client->search($searchParams);

        if (0 !== $result['hits']['total']) {

            foreach ($result['hits']['hits'] as $hit) {
                $resultSet = new stdClass();
                $resultSet->id = $hit['_source']['id'];
                $resultSet->lang = $hit['_source']['lang'];
                $resultSet->question = $hit['_source']['question'];
                $resultSet->answer = $hit['_source']['answer'];
                $resultSet->keywords = $hit['_source']['keywords'];
                $resultSet->category_id = $hit['_source']['category_id'];
                $resultSet->score = $hit['_score'];

                $this->resultSet[] = $resultSet;
            }

        } else {
            $this->resultSet = [];

        }

        return $this->resultSet;
    }

    /**
     * Prepares the autocomplete search and executes it.
     *
     * @param string $searchTerm Search term for autocompletion
     *
     * @throws PMF_Search_Exception
     *
     * @return array
     */
    public function autocomplete($searchTerm)

    {

        return $this->resultSet;
    }

    /**
     * Returns the current category ID
     *
     * @return array
     */
    public function getCategoryIds()
    {
        return $this->categoryIds;
    }

    /**
     * Sets the current category ID
     *
     * @param array $categoryIds
     */
    public function setCategoryIds(Array $categoryIds)
    {
        $this->categoryIds = $categoryIds;
    }

    /**
     * Returns the current language, empty string if all languages
     *
     * @return string
     */
    public function getLanguage()
    {
        return $this->language;
    }

    /**
     * Sets the current language
     *
     * @param string $language
     */
    public function setLanguage($language)
    {
        $this->language = $language;
    }
}


1			<?php
2
3			use Elasticsearch\Client;
4
5			/**
6			* phpMyFAQ Elasticsearch based search classes.
7			*
8			* PHP Version 5.5
9			*
10			* This Source Code Form is subject to the terms of the Mozilla Public License,
11			* v. 2.0. If a copy of the MPL was not distributed with this file, You can
12			* obtain one at http://mozilla.org/MPL/2.0/.
13			*
14			* @category phpMyFAQ
15			* @author Thorsten Rinne <[email protected]>
16			* @copyright 2015 phpMyFAQ Team
17			* @license http://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
18			* @link http://www.phpmyfaq.de
19			* @since 2015-12-25
20			*/
21			if (!defined('IS_VALID_PHPMYFAQ')) {
22			exit();
23			}
24
25			/**
26			* PMF_Search_Elasticsearch.
27			*
28			* @category phpMyFAQ
29			* @author Thorsten Rinne <[email protected]>
30			* @copyright 2015 phpMyFAQ Team
31			* @license http://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
32			* @link http://www.phpmyfaq.de
33			* @since 2015-12-25
34			*/
35			class PMF_Search_Elasticsearch extends PMF_Search_Abstract implements PMF_Search_Interface
36			{
37			/** @var Client */
38			private $client = null;
39
40			/** @var array */
41			private $esConfig = [];
42
43			/** @var string */
44			private $language = '';
45
46			/** @var array */
47			private $categoryIds = [];
48
49			/**
50			* Constructor.
51			*
52			* @param PMF_Configuration
53			*/
54			public function __construct(PMF_Configuration $config)
55			{
56			parent::__construct($config);
57
58			$this->client = $this->_config->getElasticsearch();
59			$this->esConfig = $this->_config->getElasticsearchConfig();
60			}
61
62			/**
63			* Prepares the search and executes it.
64			*
65			* @param string $searchTerm Search term
66			*
67			* @throws PMF_Search_Exception
68			*
69			* @return array
70			*/
71			public function search($searchTerm)
72			{
73			if ('' !== $this->getLanguage()) {
74			$languageFilter = [
75			'term' => [
76			'lang' => $this->getLanguage()
77			]
78			];
79			} else {
80			$languageFilter = '';
81			}
82
83			$searchParams = [
84			'index' => $this->esConfig['index'],
85			'type' => $this->esConfig['type'],
86			'size' => 1000,
87			'body' => [
88			'query' => [
89			'filtered' => [
90			'filter' => [
91			'bool' => [
92			'must' => [
93			[
94			'terms' => [ 'category_id' => $this->getCategoryIds() ]
95			],
96			$languageFilter
97			]
98			]
99			],
100			'query' => [
101			'bool' => [
102			'should' => [
103			[ 'match' => [ 'question' => $searchTerm ] ],
104			[ 'match' => [ 'answer' => $searchTerm ] ],
105			[ 'match' => [ 'keywords' => $searchTerm ] ]
106			]
107			]
108			]
109			]
110			]
111			]
112			];
113
114			$result = $this->client->search($searchParams);
115
116			if (0 !== $result['hits']['total']) {
117
118			foreach ($result['hits']['hits'] as $hit) {
119			$resultSet = new stdClass();
120			$resultSet->id = $hit['_source']['id'];
121			$resultSet->lang = $hit['_source']['lang'];
122			$resultSet->question = $hit['_source']['question'];
123			$resultSet->answer = $hit['_source']['answer'];
124			$resultSet->keywords = $hit['_source']['keywords'];
125			$resultSet->category_id = $hit['_source']['category_id'];
126			$resultSet->score = $hit['_score'];
127
128			$this->resultSet[] = $resultSet;
129			}
130
131			} else {
132			$this->resultSet = [];
			0 ignored issues – show Documentation Bug introduced 2015-12-27 20:15 UTC by Report Bug Copy Issue Report It seems like `array()` of type `array` is incompatible with the declared type `resource` of property `$resultSet`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
133			}
134
135			return $this->resultSet;
136			}
137
138			/**
139			* Prepares the autocomplete search and executes it.
140			*
141			* @param string $searchTerm Search term for autocompletion
142			*
143			* @throws PMF_Search_Exception
144			*
145			* @return array
146			*/
147			public function autocomplete($searchTerm)
			0 ignored issues – show Unused Code introduced 2015-12-29 12:44 UTC by Report Bug Copy Issue Report The parameter `$searchTerm` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
148			{
149
150			return $this->resultSet;
151			}
152
153			/**
154			* Returns the current category ID
155			*
156			* @return array
157			*/
158			public function getCategoryIds()
159			{
160			return $this->categoryIds;
161			}
162
163			/**
164			* Sets the current category ID
165			*
166			* @param array $categoryIds
167			*/
168			public function setCategoryIds(Array $categoryIds)
169			{
170			$this->categoryIds = $categoryIds;
171			}
172
173			/**
174			* Returns the current language, empty string if all languages
175			*
176			* @return string
177			*/
178			public function getLanguage()
179			{
180			return $this->language;
181			}
182
183			/**
184			* Sets the current language
185			*
186			* @param string $language
187			*/
188			public function setLanguage($language)
189			{
190			$this->language = $language;
191			}
192			}
193

thorsten / phpMyFAQ

GitHub Access Token became invalid

Push — 2.9 ( e1b57e...0e03d0 )

PMF_Search_Elasticsearch::search() B

Complexity

Size

Duplication

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like