Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
1 | <?php |
2 | |
3 | /** |
4 | * Database service interface for OaiResumption. |
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 Database |
25 | * @author Demian Katz <demian.katz@villanova.edu> |
26 | * @author Sudharma Kellampalli <skellamp@villanova.edu> |
27 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
28 | * @link https://vufind.org/wiki/development:plugins:database_gateways Wiki |
29 | */ |
30 | |
31 | namespace VuFind\Db\Service; |
32 | |
33 | use VuFind\Db\Entity\OaiResumptionEntityInterface; |
34 | |
35 | /** |
36 | * Database service interface for OaiResumption. |
37 | * |
38 | * @category VuFind |
39 | * @package Database |
40 | * @author Demian Katz <demian.katz@villanova.edu> |
41 | * @author Sudharma Kellampalli <skellamp@villanova.edu> |
42 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
43 | * @link https://vufind.org/wiki/development:plugins:database_gateways Wiki |
44 | */ |
45 | interface OaiResumptionServiceInterface |
46 | { |
47 | /** |
48 | * Remove all expired tokens from the database. |
49 | * |
50 | * @return void |
51 | */ |
52 | public function removeExpired(): void; |
53 | |
54 | /** |
55 | * Retrieve a row from the database based on primary key; return null if it |
56 | * is not found. |
57 | * |
58 | * @param string $token The resumption token to retrieve. |
59 | * |
60 | * @return ?OaiResumptionEntityInterface |
61 | */ |
62 | public function findToken(string $token): ?OaiResumptionEntityInterface; |
63 | |
64 | /** |
65 | * Create and persist a new resumption token. |
66 | * |
67 | * @param array $params Parameters associated with the token. |
68 | * @param int $expire Expiration time for token (Unix timestamp). |
69 | * |
70 | * @return OaiResumptionEntityInterface |
71 | * @throws \Exception |
72 | */ |
73 | public function createAndPersistToken(array $params, int $expire): OaiResumptionEntityInterface; |
74 | |
75 | /** |
76 | * Create a OaiResumption entity object. |
77 | * |
78 | * @return OaiResumptionEntityInterface |
79 | */ |
80 | public function createEntity(): OaiResumptionEntityInterface; |
81 | } |