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 HandlerInterface |
5 | * |
6 | * PHP version 8 |
7 | * |
8 | * Copyright (C) Moravian Library 2022. |
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 Form |
25 | * @author Josef Moravec <moravec@mzk.cz> |
26 | * @license https://opensource.org/licenses/gpl-2.0.php GNU General Public License |
27 | * @link https://vufind.org/wiki/development Wiki |
28 | */ |
29 | |
30 | declare(strict_types=1); |
31 | |
32 | namespace VuFind\Form\Handler; |
33 | |
34 | use VuFind\Db\Entity\UserEntityInterface; |
35 | |
36 | /** |
37 | * Interface HandlerInterface |
38 | * |
39 | * @category VuFind |
40 | * @package Form |
41 | * @author Josef Moravec <moravec@mzk.cz> |
42 | * @license https://opensource.org/licenses/gpl-2.0.php GNU General Public License |
43 | * @link https://vufind.org/wiki/development Wiki |
44 | */ |
45 | interface HandlerInterface |
46 | { |
47 | /** |
48 | * Get data from submitted form and process them. |
49 | * |
50 | * @param \VuFind\Form\Form $form Submitted form |
51 | * @param \Laminas\Mvc\Controller\Plugin\Params $params Request params |
52 | * @param ?UserEntityInterface $user Authenticated user |
53 | * |
54 | * @return bool |
55 | */ |
56 | public function handle( |
57 | \VuFind\Form\Form $form, |
58 | \Laminas\Mvc\Controller\Plugin\Params $params, |
59 | ?UserEntityInterface $user = null |
60 | ): bool; |
61 | } |