Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
16 / 16
100.00% covered (success)
100.00%
3 / 3
CRAP
100.00% covered (success)
100.00%
1 / 1
HttpErrorException
100.00% covered (success)
100.00%
16 / 16
100.00% covered (success)
100.00%
3 / 3
4
100.00% covered (success)
100.00%
1 / 1
 createFromResponse
100.00% covered (success)
100.00%
13 / 13
100.00% covered (success)
100.00%
1 / 1
2
 __construct
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 getResponse
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
1<?php
2
3/**
4 * HTTP error exception.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2010.
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
30namespace VuFindSearch\Backend\Exception;
31
32use Exception;
33use Laminas\Http\Response;
34
35/**
36 * HTTP error exception.
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 */
44abstract class HttpErrorException extends BackendException
45{
46    /**
47     * Server response.
48     *
49     * @var Response
50     */
51    protected $response;
52
53    /**
54     * Exception factory.
55     *
56     * Returns a RequestErrorException or RemoteErrorException depending on
57     * the response's status code.
58     *
59     * @param Response $response Server response
60     *
61     * @return RequestErrorException|RemoteErrorException
62     */
63    public static function createFromResponse(Response $response)
64    {
65        $status = $response->getStatusCode();
66        $phrase = $response->getReasonPhrase();
67        if ($status >= 500) {
68            return new RemoteErrorException(
69                $status . ' ' . $phrase,
70                $status,
71                $response
72            );
73        } else {
74            return new RequestErrorException(
75                $status . ' ' . $phrase,
76                $status,
77                $response
78            );
79        }
80    }
81
82    /**
83     * Constructor.
84     *
85     * @param string    $message  Exception message
86     * @param int       $code     Exception code
87     * @param Response  $response Server response
88     * @param Exception $prev     Previous exception
89     *
90     * @return void
91     */
92    public function __construct(
93        $message,
94        $code,
95        Response $response,
96        Exception $prev = null
97    ) {
98        parent::__construct($message, $code, $prev);
99        $this->response = $response;
100    }
101
102    /**
103     * Return server response.
104     *
105     * @return Response
106     */
107    public function getResponse()
108    {
109        return $this->response;
110    }
111}