xref: /plugin/davcal/vendor/sabre/http/lib/HttpException.php (revision a1a3b6794e0e143a4a8b51d3185ce2d339be61ab)
1*a1a3b679SAndreas Boehler<?php
2*a1a3b679SAndreas Boehler
3*a1a3b679SAndreas Boehlernamespace Sabre\HTTP;
4*a1a3b679SAndreas Boehler
5*a1a3b679SAndreas Boehler/**
6*a1a3b679SAndreas Boehler * An exception representing a HTTP error.
7*a1a3b679SAndreas Boehler *
8*a1a3b679SAndreas Boehler * This can be used as a generic exception in your application, if you'd like
9*a1a3b679SAndreas Boehler * to map HTTP errors to exceptions.
10*a1a3b679SAndreas Boehler *
11*a1a3b679SAndreas Boehler * If you'd like to use this, create a new exception class, extending Exception
12*a1a3b679SAndreas Boehler * and implementing this interface.
13*a1a3b679SAndreas Boehler *
14*a1a3b679SAndreas Boehler * @copyright Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/).
15*a1a3b679SAndreas Boehler * @author Evert Pot (http://evertpot.com/)
16*a1a3b679SAndreas Boehler * @license http://sabre.io/license/ Modified BSD License
17*a1a3b679SAndreas Boehler */
18*a1a3b679SAndreas Boehlerinterface HttpException {
19*a1a3b679SAndreas Boehler
20*a1a3b679SAndreas Boehler    /**
21*a1a3b679SAndreas Boehler     * The http status code for the error.
22*a1a3b679SAndreas Boehler     *
23*a1a3b679SAndreas Boehler     * This may either be just the number, or a number and a human-readable
24*a1a3b679SAndreas Boehler     * message, separated by a space.
25*a1a3b679SAndreas Boehler     *
26*a1a3b679SAndreas Boehler     * @return string|null
27*a1a3b679SAndreas Boehler     */
28*a1a3b679SAndreas Boehler    function getHttpStatus();
29*a1a3b679SAndreas Boehler
30*a1a3b679SAndreas Boehler}
31