Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 3 |
|
0.00% |
0 / 2 |
CRAP | |
0.00% |
0 / 1 |
| DeepPagingException | |
0.00% |
0 / 3 |
|
0.00% |
0 / 2 |
6 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
2 | |||
| getLegalPage | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Exception for paging too deep into search results. |
| 5 | * |
| 6 | * PHP version 8 |
| 7 | * |
| 8 | * Copyright (C) Villanova University 2020. |
| 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 Search |
| 25 | * @author David Maus <maus@hab.de> |
| 26 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
| 27 | * @link https://vufind.org |
| 28 | */ |
| 29 | |
| 30 | namespace VuFindSearch\Backend\Exception; |
| 31 | |
| 32 | use Exception; |
| 33 | use VuFindSearch\Exception\RuntimeException; |
| 34 | |
| 35 | /** |
| 36 | * Exception for paging too deep into search results. |
| 37 | * |
| 38 | * @category VuFind |
| 39 | * @package Search |
| 40 | * @author David Maus <maus@hab.de> |
| 41 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
| 42 | * @link https://vufind.org |
| 43 | */ |
| 44 | class DeepPagingException extends RuntimeException |
| 45 | { |
| 46 | /** |
| 47 | * A legal page number. |
| 48 | * |
| 49 | * @var int |
| 50 | */ |
| 51 | protected $legalPage; |
| 52 | |
| 53 | /** |
| 54 | * Constructor. |
| 55 | * |
| 56 | * @param string $message Exception message |
| 57 | * @param int $code Exception code |
| 58 | * @param int $legalPage A legal page number for results |
| 59 | * @param Exception $prev Previous exception |
| 60 | * |
| 61 | * @return void |
| 62 | */ |
| 63 | public function __construct( |
| 64 | $message, |
| 65 | $code, |
| 66 | $legalPage = 0, |
| 67 | Exception $prev = null |
| 68 | ) { |
| 69 | parent::__construct($message, $code, $prev); |
| 70 | $this->legalPage = $legalPage; |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Get a legal page we can redirect the user to. |
| 75 | * |
| 76 | * @return int |
| 77 | */ |
| 78 | public function getLegalPage() |
| 79 | { |
| 80 | return $this->legalPage; |
| 81 | } |
| 82 | } |