Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | |
100.00% |
7 / 7 |
|
100.00% |
3 / 3 |
CRAP | |
100.00% |
1 / 1 |
CleanUpRecordCacheCommand | |
100.00% |
7 / 7 |
|
100.00% |
3 / 3 |
3 | |
100.00% |
1 / 1 |
__construct | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
configure | |
100.00% |
3 / 3 |
|
100.00% |
1 / 1 |
1 | |||
execute | |
100.00% |
3 / 3 |
|
100.00% |
1 / 1 |
1 |
1 | <?php |
2 | |
3 | /** |
4 | * Console command: clean up record cache. |
5 | * |
6 | * PHP version 8 |
7 | * |
8 | * Copyright (C) Villanova University 2020. |
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 Console |
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 VuFindConsole\Command\Util; |
31 | |
32 | use Symfony\Component\Console\Attribute\AsCommand; |
33 | use Symfony\Component\Console\Command\Command; |
34 | use Symfony\Component\Console\Input\InputInterface; |
35 | use Symfony\Component\Console\Output\OutputInterface; |
36 | use VuFind\Db\Service\RecordServiceInterface; |
37 | |
38 | /** |
39 | * Console command: clean up record cache. |
40 | * |
41 | * @category VuFind |
42 | * @package Console |
43 | * @author Demian Katz <demian.katz@villanova.edu> |
44 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
45 | * @link https://vufind.org/wiki/development Wiki |
46 | */ |
47 | #[AsCommand( |
48 | name: 'util/cleanup_record_cache', |
49 | description: 'Record cache cleaner' |
50 | )] |
51 | class CleanUpRecordCacheCommand extends Command |
52 | { |
53 | /** |
54 | * Constructor |
55 | * |
56 | * @param RecordServiceInterface $recordService Record database service |
57 | * @param ?string $name The name of the command; passing null means it |
58 | * must be set in configure() |
59 | */ |
60 | public function __construct(protected RecordServiceInterface $recordService, ?string $name = null) |
61 | { |
62 | parent::__construct($name); |
63 | } |
64 | |
65 | /** |
66 | * Configure the command. |
67 | * |
68 | * @return void |
69 | */ |
70 | protected function configure() |
71 | { |
72 | $this |
73 | ->setHelp('Removes unused cached records from the database.') |
74 | ->setAliases(['util/cleanuprecordcache']); |
75 | } |
76 | |
77 | /** |
78 | * Run the command. |
79 | * |
80 | * @param InputInterface $input Input object |
81 | * @param OutputInterface $output Output object |
82 | * |
83 | * @return int 0 for success |
84 | * |
85 | * @SuppressWarnings(PHPMD.UnusedFormalParameter) |
86 | */ |
87 | protected function execute(InputInterface $input, OutputInterface $output) |
88 | { |
89 | $count = $this->recordService->cleanup(); |
90 | $output->writeln("$count records deleted."); |
91 | return 0; |
92 | } |
93 | } |