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 | * Interface for representing a session row. |
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 Db_Interface |
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 Main Site |
28 | */ |
29 | |
30 | namespace VuFind\Db\Entity; |
31 | |
32 | use DateTime; |
33 | |
34 | /** |
35 | * Interface for representing a session row. |
36 | * |
37 | * @category VuFind |
38 | * @package Db_Interface |
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 Main Site |
42 | */ |
43 | interface SessionEntityInterface extends EntityInterface |
44 | { |
45 | /** |
46 | * Id getter |
47 | * |
48 | * @return int |
49 | */ |
50 | public function getId(): int; |
51 | |
52 | /** |
53 | * Session Id setter |
54 | * |
55 | * @param ?string $sid Session Id. |
56 | * |
57 | * @return SessionEntityInterface |
58 | */ |
59 | public function setSessionId(?string $sid): SessionEntityInterface; |
60 | |
61 | /** |
62 | * Created setter. |
63 | * |
64 | * @param DateTime $dateTime Created date |
65 | * |
66 | * @return SessionEntityInterface |
67 | */ |
68 | public function setCreated(DateTime $dateTime): SessionEntityInterface; |
69 | |
70 | /** |
71 | * Set time the session is last used. |
72 | * |
73 | * @param int $lastUsed Time last used |
74 | * |
75 | * @return SessionEntityInterface |
76 | */ |
77 | public function setLastUsed(int $lastUsed): SessionEntityInterface; |
78 | |
79 | /** |
80 | * Get time when the session was last used. |
81 | * |
82 | * @return int |
83 | */ |
84 | public function getLastUsed(): int; |
85 | |
86 | /** |
87 | * Session data setter. |
88 | * |
89 | * @param ?string $data Session data. |
90 | * |
91 | * @return SessionEntityInterface |
92 | */ |
93 | public function setData(?string $data): SessionEntityInterface; |
94 | |
95 | /** |
96 | * Get session data. |
97 | * |
98 | * @return ?string |
99 | */ |
100 | public function getData(): ?string; |
101 | } |