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 * Session handler interface
5 *
6 * Copyright (C) Villanova University 2018,
7 *               Leipzig University Library <info@ub.uni-leipzig.de> 2018.
8 *
9 * PHP version 8
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2,
13 * as published by the Free Software Foundation.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
23 *
24 * @category VuFind
25 * @package  Session_Handlers
26 * @author   Demian Katz <demian.katz@villanova.edu>
27 * @author   Sebastian Kehr <kehr@ub.uni-leipzig.de>
28 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
29 * @link     https://vufind.org/wiki/development:plugins:session_handlers Wiki
30 */
31
32namespace VuFind\Session;
33
34use Laminas\Session\SaveHandler\SaveHandlerInterface;
35use VuFind\Db\Table\DbTableAwareInterface;
36
37/**
38 * Session handler interface
39 *
40 * @category VuFind
41 * @package  Session_Handlers
42 * @author   Demian Katz <demian.katz@villanova.edu>
43 * @author   Sebastian Kehr <kehr@ub.uni-leipzig.de>
44 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
45 * @link     https://vufind.org/wiki/development:plugins:session_handlers Wiki
46 */
47interface HandlerInterface extends SaveHandlerInterface, DbTableAwareInterface
48{
49    /**
50     * Enable session writing (default)
51     *
52     * @return void
53     */
54    public function enableWrites();
55
56    /**
57     * Disable session writing, i.e. make it read-only
58     *
59     * @return void
60     */
61    public function disableWrites();
62}