Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | |
100.00% |
6 / 6 |
|
100.00% |
1 / 1 |
CRAP | |
100.00% |
1 / 1 |
GetUniqueKeyCommand | |
100.00% |
6 / 6 |
|
100.00% |
1 / 1 |
3 | |
100.00% |
1 / 1 |
execute | |
100.00% |
6 / 6 |
|
100.00% |
1 / 1 |
3 |
1 | <?php |
2 | |
3 | /** |
4 | * Get the backend's unique search key field (currently only supported by Solr) |
5 | * |
6 | * PHP version 8 |
7 | * |
8 | * Copyright (C) Villanova University 2021. |
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 Demian Katz <demian.katz@villanova.edu> |
26 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
27 | * @link https://vufind.org |
28 | */ |
29 | |
30 | namespace VuFindSearch\Command; |
31 | |
32 | use VuFindSearch\Backend\BackendInterface; |
33 | |
34 | use function is_callable; |
35 | |
36 | /** |
37 | * Get the backend's unique search key field (currently only supported by Solr) |
38 | * |
39 | * @category VuFind |
40 | * @package Search |
41 | * @author Demian Katz <demian.katz@villanova.edu> |
42 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
43 | * @link https://vufind.org |
44 | */ |
45 | class GetUniqueKeyCommand extends AbstractBase |
46 | { |
47 | /** |
48 | * Execute command on backend. |
49 | * |
50 | * @param BackendInterface $backend Backend |
51 | * |
52 | * @return CommandInterface Command instance for method chaining |
53 | */ |
54 | public function execute(BackendInterface $backend): CommandInterface |
55 | { |
56 | $this->validateBackend($backend); |
57 | if (is_callable([$backend, 'getConnector'])) { |
58 | $connector = $backend->getConnector(); |
59 | if (is_callable([$connector, 'getUniqueKey'])) { |
60 | return $this->finalizeExecution($connector->getUniqueKey()); |
61 | } |
62 | } |
63 | throw new \Exception('Unsupported backend.'); |
64 | } |
65 | } |