aboutsummaryrefslogblamecommitdiffstats
path: root/vendor/sabre/dav/lib/DAV/Exception.php
blob: e1d9906234bd1180fff729a9e1f5de9ab96f5f37 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12
13
14

     

                        









                                                                                                                     



                                                           
   

                                  
       
                                                      


                  

                                 
                   


       
                                                                                                         
      
                                 
                                    
       

                                                                     







                                                                                  
      

                    

                                                  
                  
     
 
<?php

declare(strict_types=1);

namespace Sabre\DAV;

/**
 * Main Exception class.
 *
 * This class defines a getHTTPCode method, which should return the appropriate HTTP code for the Exception occurred.
 * The default for this is 500.
 *
 * This class also allows you to generate custom xml data for your exceptions. This will be displayed
 * in the 'error' element in the failing response.
 *
 * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
 * @author Evert Pot (http://evertpot.com/)
 * @license http://sabre.io/license/ Modified BSD License
 */
class Exception extends \Exception
{
    /**
     * Returns the HTTP statuscode for this exception.
     *
     * @return int
     */
    public function getHTTPCode()
    {
        return 500;
    }

    /**
     * This method allows the exception to include additional information into the WebDAV error response.
     *
     * @param Server      $server
     * @param \DOMElement $errorNode
     */
    public function serialize(Server $server, \DOMElement $errorNode)
    {
    }

    /**
     * This method allows the exception to return any extra HTTP response headers.
     *
     * The headers must be returned as an array.
     *
     * @param Server $server
     *
     * @return array
     */
    public function getHTTPHeaders(Server $server)
    {
        return [];
    }
}