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 auth_hash 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
30namespace VuFind\Db\Service;
31
32use VuFind\Db\Entity\AuthHashEntityInterface;
33
34/**
35 * Database service for auth_hash 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 */
43interface AuthHashServiceInterface extends DbServiceInterface
44{
45    public const TYPE_EMAIL = 'email'; // EmailAuthenticator
46
47    /**
48     * Create an auth_hash entity object.
49     *
50     * @return AuthHashEntityInterface
51     */
52    public function createEntity(): AuthHashEntityInterface;
53
54    /**
55     * Delete an auth_hash entity object.
56     *
57     * @param AuthHashEntityInterface|int $authHashOrId Object or ID value representing auth_hash to delete
58     *
59     * @return void
60     */
61    public function deleteAuthHash(AuthHashEntityInterface|int $authHashOrId): void;
62
63    /**
64     * Retrieve an object from the database based on hash and type; possibly create a new
65     * row if no existing match is found.
66     *
67     * @param string $hash   Hash
68     * @param string $type   Hash type
69     * @param bool   $create Should we create rows that don't already exist?
70     *
71     * @return ?AuthHashEntityInterface
72     */
73    public function getByHashAndType(string $hash, string $type, bool $create = true): ?AuthHashEntityInterface;
74
75    /**
76     * Retrieve last object from the database based on session id.
77     *
78     * @param string $sessionId Session ID
79     *
80     * @return ?AuthHashEntityInterface
81     */
82    public function getLatestBySessionId(string $sessionId): ?AuthHashEntityInterface;
83}