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 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
30namespace VuFind\Db\Service;
31
32use VuFind\Db\Entity\AccessTokenEntityInterface;
33
34/**
35 * Database service interface for access tokens.
36 *
37 * @category VuFind
38 * @package  Database
39 * @author   Aleksi Peebles <aleksi.peebles@helsinki.fi>
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 */
43interface AccessTokenServiceInterface extends DbServiceInterface
44{
45    /**
46     * Retrieve an object from the database based on id and type; create a new
47     * row if no existing match is found.
48     *
49     * @param string $id     Token ID
50     * @param string $type   Token type
51     * @param bool   $create Should we create rows that don't already exist?
52     *
53     * @return ?AccessTokenEntityInterface
54     */
55    public function getByIdAndType(
56        string $id,
57        string $type,
58        bool $create = true
59    ): ?AccessTokenEntityInterface;
60
61    /**
62     * Add or replace an OpenID nonce for a user
63     *
64     * @param int     $userId User ID
65     * @param ?string $nonce  Nonce
66     *
67     * @return void
68     */
69    public function storeNonce(int $userId, ?string $nonce): void;
70
71    /**
72     * Retrieve an OpenID nonce for a user
73     *
74     * @param int $userId User ID
75     *
76     * @return ?string
77     */
78    public function getNonce(int $userId): ?string;
79}