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 Session.
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\SessionEntityInterface;
33
34/**
35 * Database service interface for Session.
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 SessionServiceInterface extends DbServiceInterface
44{
45    /**
46     * Retrieve an object from the database based on session ID; create a new
47     * row if no existing match is found.
48     *
49     * @param string $sid    Session ID to retrieve
50     * @param bool   $create Should we create rows that don't already exist?
51     *
52     * @return ?SessionEntityInterface
53     */
54    public function getSessionById(string $sid, bool $create = true): ?SessionEntityInterface;
55
56    /**
57     * Retrieve data for the given session ID.
58     *
59     * @param string $sid      Session ID to retrieve
60     * @param int    $lifetime Session lifetime (in seconds)
61     *
62     * @throws SessionExpiredException
63     * @return string     Session data
64     */
65    public function readSession(string $sid, int $lifetime): string;
66
67    /**
68     * Store data for the given session ID.
69     *
70     * @param string $sid  Session ID to retrieve
71     * @param string $data Data to store
72     *
73     * @return bool
74     */
75    public function writeSession(string $sid, string $data): bool;
76
77    /**
78     * Destroy data for the given session ID.
79     *
80     * @param string $sid Session ID to erase
81     *
82     * @return void
83     */
84    public function destroySession(string $sid): void;
85
86    /**
87     * Garbage collect expired sessions.
88     *
89     * @param int $maxLifetime Maximum session lifetime.
90     *
91     * @return void
92     */
93    public function garbageCollect(int $maxLifetime): void;
94
95    /**
96     * Create a session entity object.
97     *
98     * @return SessionEntityInterface
99     */
100    public function createEntity(): SessionEntityInterface;
101}