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 | * Entity model interface for access tokens. |
5 | * |
6 | * PHP version 8 |
7 | * |
8 | * Copyright (C) The National Library of Finland 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 Aleksi Peebles <aleksi.peebles@helsinki.fi> |
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\Entity; |
31 | |
32 | /** |
33 | * Entity model interface for access tokens. |
34 | * |
35 | * @category VuFind |
36 | * @package Database |
37 | * @author Aleksi Peebles <aleksi.peebles@helsinki.fi> |
38 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
39 | * @link https://vufind.org/wiki/development:plugins:database_gateways Wiki |
40 | */ |
41 | interface AccessTokenEntityInterface extends EntityInterface |
42 | { |
43 | /** |
44 | * Set user ID. |
45 | * |
46 | * @param ?UserEntityInterface $user User owning token |
47 | * |
48 | * @return AccessTokenEntityInterface |
49 | */ |
50 | public function setUser(?UserEntityInterface $user): AccessTokenEntityInterface; |
51 | |
52 | /** |
53 | * Set data. |
54 | * |
55 | * @param string $data Data |
56 | * |
57 | * @return AccessTokenEntityInterface |
58 | */ |
59 | public function setData(string $data): AccessTokenEntityInterface; |
60 | |
61 | /** |
62 | * Is the access token revoked? |
63 | * |
64 | * @return bool |
65 | */ |
66 | public function isRevoked(): bool; |
67 | |
68 | /** |
69 | * Set revoked status. |
70 | * |
71 | * @param bool $revoked Revoked |
72 | * |
73 | * @return AccessTokenEntityInterface |
74 | */ |
75 | public function setRevoked(bool $revoked): AccessTokenEntityInterface; |
76 | } |