Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | |
100.00% |
5 / 5 |
|
100.00% |
2 / 2 |
CRAP | |
100.00% |
1 / 1 |
SearchBackendEventManagerTrait | |
100.00% |
5 / 5 |
|
100.00% |
2 / 2 |
3 | |
100.00% |
1 / 1 |
setEventManager | |
100.00% |
2 / 2 |
|
100.00% |
1 / 1 |
1 | |||
getEventManager | |
100.00% |
3 / 3 |
|
100.00% |
1 / 1 |
2 |
1 | <?php |
2 | |
3 | /** |
4 | * Trait to compose the event manager into a search class. |
5 | * |
6 | * PHP version 8 |
7 | * |
8 | * Copyright (C) Villanova University 2024. |
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\Feature; |
31 | |
32 | use Laminas\EventManager\EventManager; |
33 | use Laminas\EventManager\EventManagerInterface; |
34 | |
35 | /** |
36 | * Trait to compose the event manager into a search class. |
37 | * |
38 | * @category VuFind |
39 | * @package Search |
40 | * @author Demian Katz <demian.katz@villanova.edu> |
41 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
42 | * @link https://vufind.org |
43 | */ |
44 | trait SearchBackendEventManagerTrait |
45 | { |
46 | /** |
47 | * Event manager. |
48 | * |
49 | * @var EventManager |
50 | */ |
51 | protected $events; |
52 | |
53 | /** |
54 | * Set EventManager instance. |
55 | * |
56 | * @param EventManagerInterface $events Event manager |
57 | * |
58 | * @return void |
59 | */ |
60 | public function setEventManager(EventManagerInterface $events) |
61 | { |
62 | // Using the class name as the event namespace is recommended; the |
63 | // VuFind\Search and VuFindSearch values are only retained for backward |
64 | // compatibility. |
65 | $events->setIdentifiers([\VuFindSearch\Service::class, 'VuFind\Search', 'VuFindSearch']); |
66 | $this->events = $events; |
67 | } |
68 | |
69 | /** |
70 | * Return EventManager instance. |
71 | * |
72 | * Lazy loads a new EventManager if none was set. |
73 | * |
74 | * @return EventManagerInterface |
75 | */ |
76 | public function getEventManager() |
77 | { |
78 | if (!$this->events) { |
79 | $this->setEventManager(new EventManager()); |
80 | } |
81 | return $this->events; |
82 | } |
83 | } |