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 for external_session table. |
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 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
27 | * @link https://vufind.org/wiki/development:plugins:database_gateways Wiki |
28 | */ |
29 | |
30 | namespace VuFind\Db\Service; |
31 | |
32 | use VuFind\Db\Entity\ExternalSessionEntityInterface; |
33 | |
34 | /** |
35 | * Database service for external_session table. |
36 | * |
37 | * @category VuFind |
38 | * @package Database |
39 | * @author Demian Katz <demian.katz@villanova.edu> |
40 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
41 | * @link https://vufind.org/wiki/development:plugins:database_gateways Wiki |
42 | */ |
43 | interface ExternalSessionServiceInterface extends DbServiceInterface |
44 | { |
45 | /** |
46 | * Create a new external session entity. |
47 | * |
48 | * @return ExternalSessionEntityInterface |
49 | */ |
50 | public function createEntity(): ExternalSessionEntityInterface; |
51 | |
52 | /** |
53 | * Add a mapping between local and external session id's; return the newly-created entity. |
54 | * |
55 | * @param string $localSessionId Local (VuFind) session id |
56 | * @param string $externalSessionId External session id |
57 | * |
58 | * @return ExternalSessionEntityInterface |
59 | */ |
60 | public function addSessionMapping( |
61 | string $localSessionId, |
62 | string $externalSessionId |
63 | ): ExternalSessionEntityInterface; |
64 | |
65 | /** |
66 | * Retrieve objects from the database based on an external session ID |
67 | * |
68 | * @param string $sid External session ID to retrieve |
69 | * |
70 | * @return ExternalSessionEntityInterface[] |
71 | */ |
72 | public function getAllByExternalSessionId(string $sid): array; |
73 | |
74 | /** |
75 | * Destroy data for the given session ID. |
76 | * |
77 | * @param string $sid Session ID to erase |
78 | * |
79 | * @return void |
80 | */ |
81 | public function destroySession(string $sid): void; |
82 | } |