Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | |
0.00% |
0 / 24 |
|
0.00% |
0 / 3 |
CRAP | |
0.00% |
0 / 1 |
IndexFactory | |
0.00% |
0 / 24 |
|
0.00% |
0 / 3 |
56 | |
0.00% |
0 / 1 |
__invoke | |
0.00% |
0 / 11 |
|
0.00% |
0 / 1 |
6 | |||
getBackendSettings | |
0.00% |
0 / 10 |
|
0.00% |
0 / 1 |
12 | |||
getIdFetcher | |
0.00% |
0 / 3 |
|
0.00% |
0 / 1 |
6 |
1 | <?php |
2 | |
3 | /** |
4 | * Index-based generator plugin factory |
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 Sitemap |
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/wiki/development Wiki |
28 | */ |
29 | |
30 | namespace VuFind\Sitemap\Plugin; |
31 | |
32 | use Laminas\ServiceManager\Exception\ServiceNotCreatedException; |
33 | use Laminas\ServiceManager\Exception\ServiceNotFoundException; |
34 | use Laminas\ServiceManager\Factory\FactoryInterface; |
35 | use Psr\Container\ContainerExceptionInterface as ContainerException; |
36 | use Psr\Container\ContainerInterface; |
37 | |
38 | use function is_callable; |
39 | |
40 | /** |
41 | * Index-based generator plugin factory |
42 | * |
43 | * @category VuFind |
44 | * @package Sitemap |
45 | * @author Demian Katz <demian.katz@villanova.edu> |
46 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
47 | * @link https://vufind.org/wiki/development Wiki |
48 | */ |
49 | class IndexFactory implements FactoryInterface |
50 | { |
51 | /** |
52 | * Create an object |
53 | * |
54 | * @param ContainerInterface $container Service manager |
55 | * @param string $requestedName Service being created |
56 | * @param null|array $options Extra options (optional) |
57 | * |
58 | * @return object |
59 | * |
60 | * @throws ServiceNotFoundException if unable to resolve the service. |
61 | * @throws ServiceNotCreatedException if an exception is raised when |
62 | * creating a service. |
63 | * @throws ContainerException&\Throwable if any other error occurs |
64 | */ |
65 | public function __invoke( |
66 | ContainerInterface $container, |
67 | $requestedName, |
68 | array $options = null |
69 | ) { |
70 | if (!empty($options)) { |
71 | throw new \Exception('Unexpected options passed to factory.'); |
72 | } |
73 | $configLoader = $container->get(\VuFind\Config\PluginManager::class); |
74 | $sitemapConfig = $configLoader->get('sitemap'); |
75 | $retrievalMode = $sitemapConfig->Sitemap->retrievalMode ?? 'search'; |
76 | return new $requestedName( |
77 | $this->getBackendSettings($sitemapConfig), |
78 | $this->getIdFetcher($container, $retrievalMode), |
79 | $sitemapConfig->Sitemap->countPerPage ?? 10000, |
80 | (array)($sitemapConfig->Sitemap->extraFilters ?? []) |
81 | ); |
82 | } |
83 | |
84 | /** |
85 | * Process backend configuration into a convenient array. |
86 | * |
87 | * @param Config $config Sitemap config |
88 | * |
89 | * @return array |
90 | */ |
91 | protected function getBackendSettings($config): array |
92 | { |
93 | // Process backend configuration: |
94 | $backendConfig = $config->Sitemap->index ?? ['Solr,/Record/']; |
95 | if (!$backendConfig) { |
96 | return []; |
97 | } |
98 | $backendConfig = is_callable([$backendConfig, 'toArray']) |
99 | ? $backendConfig->toArray() : (array)$backendConfig; |
100 | $callback = function ($n) { |
101 | $parts = array_map('trim', explode(',', $n)); |
102 | return ['id' => $parts[0], 'url' => $parts[1]]; |
103 | }; |
104 | return array_map($callback, $backendConfig); |
105 | } |
106 | |
107 | /** |
108 | * Get the helper object for generating sitemaps through the search service. |
109 | * |
110 | * @param ContainerInterface $container Service manager |
111 | * @param string $retrievalMode Retrieval mode ('terms' or 'search') |
112 | * |
113 | * @return Index\AbstractIdFetcher |
114 | */ |
115 | protected function getIdFetcher( |
116 | ContainerInterface $container, |
117 | $retrievalMode |
118 | ): Index\AbstractIdFetcher { |
119 | $class = $retrievalMode === 'terms' |
120 | ? Index\TermsIdFetcher::class : Index\CursorMarkIdFetcher::class; |
121 | return new $class($container->get(\VuFindSearch\Service::class)); |
122 | } |
123 | } |