Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | |
100.00% |
12 / 12 |
|
100.00% |
4 / 4 |
CRAP | |
100.00% |
1 / 1 |
Terms | |
100.00% |
12 / 12 |
|
100.00% |
4 / 4 |
6 | |
100.00% |
1 / 1 |
__construct | |
100.00% |
7 / 7 |
|
100.00% |
1 / 1 |
2 | |||
getIterator | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
getFieldTerms | |
100.00% |
3 / 3 |
|
100.00% |
1 / 1 |
2 | |||
hasFieldTerms | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 |
1 | <?php |
2 | |
3 | /** |
4 | * SOLR Terms component. |
5 | * |
6 | * PHP version 8 |
7 | * |
8 | * Copyright (C) Villanova University 2010. |
9 | * |
10 | * This program is free software; you can redistribute it and/or modify |
11 | * it under the terms of the GNU General Public License version 2, |
12 | * as published by the Free Software Foundation. |
13 | * |
14 | * This program is distributed in the hope that it will be useful, |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
17 | * GNU General Public License for more details. |
18 | * |
19 | * You should have received a copy of the GNU General Public License |
20 | * along with this program; if not, write to the Free Software |
21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
22 | * |
23 | * @category VuFind |
24 | * @package Search |
25 | * @author David Maus <maus@hab.de> |
26 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
27 | * @link https://vufind.org |
28 | */ |
29 | |
30 | namespace VuFindSearch\Backend\Solr\Response\Json; |
31 | |
32 | use ArrayObject; |
33 | use IteratorAggregate; |
34 | use Traversable; |
35 | |
36 | /** |
37 | * SOLR Terms component. |
38 | * |
39 | * @category VuFind |
40 | * @package Search |
41 | * @author David Maus <maus@hab.de> |
42 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
43 | * @link https://vufind.org |
44 | */ |
45 | class Terms implements IteratorAggregate |
46 | { |
47 | /** |
48 | * Terms, indexed by field. |
49 | * |
50 | * @var ArrayObject |
51 | */ |
52 | protected $terms; |
53 | |
54 | /** |
55 | * Constructor. |
56 | * |
57 | * @param array $terms Term information |
58 | * |
59 | * @return void |
60 | */ |
61 | public function __construct(array $terms) |
62 | { |
63 | $terms = array_replace( |
64 | ['responseHeader' => [], 'terms' => []], |
65 | $terms |
66 | ); |
67 | $this->terms = new ArrayObject(); |
68 | foreach ($terms['terms'] as $field => $info) { |
69 | $this->terms->offsetSet($field, new NamedList($info)); |
70 | } |
71 | } |
72 | |
73 | /** |
74 | * Return aggregated iterator. |
75 | * |
76 | * @return Traversable |
77 | */ |
78 | public function getIterator(): Traversable |
79 | { |
80 | return $this->terms->getIterator(); |
81 | } |
82 | |
83 | /** |
84 | * Get terms for the specified field |
85 | * |
86 | * @param string $field Field name |
87 | * |
88 | * @return array |
89 | */ |
90 | public function getFieldTerms($field) |
91 | { |
92 | if ($this->hasFieldTerms($field)) { |
93 | return $this->terms->offsetGet($field); |
94 | } |
95 | return null; |
96 | } |
97 | |
98 | /** |
99 | * Does the requested field exist? |
100 | * |
101 | * @param string $field Field name |
102 | * |
103 | * @return bool |
104 | */ |
105 | public function hasFieldTerms($field) |
106 | { |
107 | return $this->terms->offsetExists($field); |
108 | } |
109 | } |