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 | * Interface for Csrf validator |
5 | * |
6 | * PHP version 8 |
7 | * |
8 | * Copyright (C) Villanova University 2018. |
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 Validator |
25 | * @author Demian Katz <demian.katz@villanova.edu> |
26 | * @author Vaclav Rosecky <vaclav.rosecky@mzk.cz> |
27 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
28 | * @link https://vufind.org/wiki/development Wiki |
29 | */ |
30 | |
31 | namespace VuFind\Validator; |
32 | |
33 | use Laminas\Validator\ValidatorInterface; |
34 | |
35 | /** |
36 | * Interface for Csrf validator |
37 | * |
38 | * @category VuFind |
39 | * @package Validator |
40 | * @author Demian Katz <demian.katz@villanova.edu> |
41 | * @author Vaclav Rosecky <vaclav.rosecky@mzk.cz> |
42 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
43 | * @link https://vufind.org/wiki/development Wiki |
44 | */ |
45 | interface CsrfInterface extends ValidatorInterface |
46 | { |
47 | /** |
48 | * Retrieve CSRF token |
49 | * |
50 | * If no CSRF token currently exists, or should be regenerated, |
51 | * generates one. |
52 | * |
53 | * @param bool $regenerate regenerate hash, default false |
54 | * |
55 | * @return string |
56 | */ |
57 | public function getHash($regenerate = false); |
58 | |
59 | /** |
60 | * Keep only the most recent N tokens. |
61 | * |
62 | * @param int $limit Number of tokens to keep. |
63 | * |
64 | * @return void |
65 | */ |
66 | public function trimTokenList($limit); |
67 | } |