1 | <?php |
---|
2 | /** |
---|
3 | * Copyright 2011 Bas de Nooijer. All rights reserved. |
---|
4 | * |
---|
5 | * Redistribution and use in source and binary forms, with or without |
---|
6 | * modification, are permitted provided that the following conditions are met: |
---|
7 | * |
---|
8 | * 1. Redistributions of source code must retain the above copyright notice, |
---|
9 | * this list of conditions and the following disclaimer. |
---|
10 | * |
---|
11 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
---|
12 | * this listof conditions and the following disclaimer in the documentation |
---|
13 | * and/or other materials provided with the distribution. |
---|
14 | * |
---|
15 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS" |
---|
16 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
17 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
18 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
---|
19 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
---|
20 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
---|
21 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
---|
22 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
---|
23 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
---|
24 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
---|
25 | * POSSIBILITY OF SUCH DAMAGE. |
---|
26 | * |
---|
27 | * The views and conclusions contained in the software and documentation are |
---|
28 | * those of the authors and should not be interpreted as representing official |
---|
29 | * policies, either expressed or implied, of the copyright holder. |
---|
30 | * |
---|
31 | * @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl> |
---|
32 | * @license http://github.com/basdenooijer/solarium/raw/master/COPYING |
---|
33 | * @link http://www.solarium-project.org/ |
---|
34 | * |
---|
35 | * @package Solarium |
---|
36 | * @subpackage Client |
---|
37 | */ |
---|
38 | |
---|
39 | /** |
---|
40 | * Solarium client HTTP exception |
---|
41 | * |
---|
42 | * This exception class exists to make it easy to catch HTTP errors. |
---|
43 | * HTTP errors usually mean your Solr settings or Solr input (e.g. query) |
---|
44 | * contain an error. |
---|
45 | * |
---|
46 | * The getMessage method returns an error description that includes the status |
---|
47 | * message and code. |
---|
48 | * |
---|
49 | * The getCode method will return the HTTP response code returned by the server |
---|
50 | * (if available). |
---|
51 | * |
---|
52 | * The getStatusMessage method will return the HTTP status message. |
---|
53 | * |
---|
54 | * @package Solarium |
---|
55 | * @subpackage Client |
---|
56 | */ |
---|
57 | class Solarium_Client_HttpException extends Solarium_Exception |
---|
58 | { |
---|
59 | |
---|
60 | /** |
---|
61 | * HTTP status message |
---|
62 | * |
---|
63 | * @var string |
---|
64 | */ |
---|
65 | protected $_statusMessage; |
---|
66 | |
---|
67 | /** |
---|
68 | * Exception constructor |
---|
69 | * |
---|
70 | * The input message is a HTTP status message. Because an exception with the |
---|
71 | * message 'Not Found' is not very clear it this message is tranformed to a |
---|
72 | * more descriptive text. The original message is available using the |
---|
73 | * {@link getStatusMessage} method. |
---|
74 | * |
---|
75 | * @param string $statusMessage |
---|
76 | * @param int|null $code |
---|
77 | */ |
---|
78 | public function __construct($statusMessage, $code = null) |
---|
79 | { |
---|
80 | $this->_statusMessage = $statusMessage; |
---|
81 | |
---|
82 | $message = 'Solr HTTP error: ' . $statusMessage; |
---|
83 | if (null !== $code) { |
---|
84 | $message .= ' (' . $code . ')'; |
---|
85 | } |
---|
86 | |
---|
87 | parent::__construct($message, $code); |
---|
88 | } |
---|
89 | |
---|
90 | /** |
---|
91 | * Get the HTTP status message |
---|
92 | * |
---|
93 | * @return string |
---|
94 | */ |
---|
95 | public function getStatusMessage() |
---|
96 | { |
---|
97 | return $this->_statusMessage; |
---|
98 | } |
---|
99 | |
---|
100 | } |
---|