class.cb_api_exception.php

<?php
/* This file is part of cbapi.
 * Copyright © 2011-2012 stiftung kulturserver.de ggmbh <github@culturebase.org>
 *
 * cbapi is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * cbapi is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with cbapi.  If not, see <http://www.gnu.org/licenses/>.
 */

Cb::import("CbHttpResponseCodes");

/**
 * Class to provide exceptions mappable to HTTP response codes. Usually this
 * will be thrown from a utility class and caught by CbContentProvider. For
 * now we can only transfer a single string message. Subclass this and provide
 * a more sophisticated getMessage to get something else.
 */
class CbApiException extends Exception {
   protected $headers;   ///< Additional HTTP headers.
   protected $user_data; ///< Data to output in HTTP body.

   /**
    * Create an API exception.
    * @param string $message Message to be shown to the user.
    * @param int $response_code HTTP response code to be set.
    * @param string|array $headers additional headers to be set (e.g. WWW-Authenticate on 401).
    */
   public function __construct($response_code = 502, $user_data = "", array $headers = array())
   {
      /* Informational and Success headers are of no use here.
       * Obviously this would indicate a problem in our application logic.
       */
      if ($response_code > 99 && $response_code < 300) $response_code = 500;
      parent::__construct(CbHttpResponseCodes::get($response_code), $response_code);
      $this->user_data = $user_data;
      $this->headers = is_array($headers) ? $headers : array($headers);
   }

   /**
    * Return the additional headers.
    * @return array The headers.
    */
   public function getHeaders()
   {
      return $this->headers;
   }

   /**
    * Output additional HTTP headers and response code header.
    */
   public function outputHeaders()
   {
      foreach($this->getHeaders() as $header) header($header);
      header("HTTP/1.0 ".$this->getCode()." ".$this->getMessage());
   }

   public function getUserData()
   {
      return $this->user_data;
   }
}