|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace smtech\StMarksSearch\LibApps\LibGuides; |
|
4
|
|
|
|
|
5
|
|
|
use smtech\StMarksSearch\Relevance; |
|
6
|
|
|
use smtech\StMarksSearch\SearchResult; |
|
7
|
|
|
use smtech\StMarksSearch\SearchSource; |
|
8
|
|
|
use smtech\StMarksSearch\LibApps\AbstractLibAppsSearchDomain; |
|
9
|
|
|
|
|
10
|
|
|
/** |
|
11
|
|
|
* LibGuides search domain |
|
12
|
|
|
* |
|
13
|
|
|
* @author Seth Battis <[email protected]> |
|
14
|
|
|
*/ |
|
15
|
|
|
class LibGuidesSearch extends AbstractLibAppsSearchDomain |
|
16
|
|
|
{ |
|
17
|
|
|
/** |
|
18
|
|
|
* Search for `$query` within the LibGuides |
|
19
|
|
|
* |
|
20
|
|
|
* @param string $query |
|
21
|
|
|
* @return SearchResult[] Ordered by descending relevance |
|
22
|
|
|
*/ |
|
23
|
|
|
public function search($query) |
|
24
|
|
|
{ |
|
25
|
|
|
$source = new SearchSource($this); |
|
26
|
|
|
$results = []; |
|
27
|
|
|
$response = $this->getApi()->get( |
|
28
|
|
|
'/guides', |
|
29
|
|
|
[ |
|
30
|
|
|
'search_terms' => $query, |
|
31
|
|
|
'search_match' => 2 // contains |
|
32
|
|
|
] |
|
33
|
|
|
); |
|
34
|
|
|
if (is_array($response)) { |
|
35
|
|
|
foreach ($response as $result) { |
|
36
|
|
|
$results[] = new SearchResult( |
|
37
|
|
|
$result['url'], |
|
38
|
|
|
$this->relevance($result, $query), |
|
39
|
|
|
$result['name'], |
|
40
|
|
|
$result['description'], |
|
41
|
|
|
$source |
|
42
|
|
|
); |
|
43
|
|
|
} |
|
44
|
|
|
} |
|
45
|
|
|
|
|
46
|
|
|
$this->sortByRelevance($results); |
|
47
|
|
|
return $results; |
|
48
|
|
|
} |
|
49
|
|
|
|
|
50
|
|
|
/** |
|
51
|
|
|
* Calculate relevance score for a particular search result |
|
52
|
|
|
* |
|
53
|
|
|
* @param mixed[] $guide |
|
54
|
|
|
* @param string $query |
|
55
|
|
|
* @return Relevance |
|
56
|
|
|
*/ |
|
57
|
|
View Code Duplication |
protected function relevance($guide, $query) |
|
|
|
|
|
|
58
|
|
|
{ |
|
59
|
|
|
$relevance = new Relevance(); |
|
60
|
|
|
|
|
61
|
|
|
$relevance->add(Relevance::stringProportion($guide['name'], $query), 'title match'); |
|
62
|
|
|
|
|
63
|
|
|
if (($count = substr_count(strtolower($guide['description']), strtolower($query))) > 0) { |
|
64
|
|
|
$relevance->add($count * 0.01, "$count occurrences in description"); |
|
65
|
|
|
} |
|
66
|
|
|
|
|
67
|
|
|
return $relevance; |
|
68
|
|
|
} |
|
69
|
|
|
} |
|
70
|
|
|
|
smtech /
stmarks-search
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.