From 425c661631b25d25a792691b44c9298383cd5d74 Mon Sep 17 00:00:00 2001 From: Alex Tselegidis Date: Sat, 9 Jul 2016 12:25:21 +0200 Subject: [PATCH] Added custom API exception class. --- src/engine/Api/V1/Exception.php | 54 +++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 src/engine/Api/V1/Exception.php diff --git a/src/engine/Api/V1/Exception.php b/src/engine/Api/V1/Exception.php new file mode 100644 index 00000000..e0b2665a --- /dev/null +++ b/src/engine/Api/V1/Exception.php @@ -0,0 +1,54 @@ + + * @copyright Copyright (c) 2013 - 2016, Alex Tselegidis + * @license http://opensource.org/licenses/GPL-3.0 - GPLv3 + * @link http://easyappointments.org + * @since v1.2.0 + * ---------------------------------------------------------------------------- */ + +namespace EA\Engine\Api\V1; + +/** + * API v1 Exception Class + * + * This exception variation will hold the information needed for exception handling in the API. + */ +class Exception extends \Exception { + /** + * Header Description + * + * e.g. 'Unauthorized' + * + * @var string + */ + protected $header; + + /** + * Class Constructor + * + * @link http://php.net/manual/en/class.exception.php + * + * @param string $message + * @param int $code + * @param string $header + * @param \Exception|null $previous + */ + public function __construct($message = null, $code = 500, $header = '', \Exception $previous = null) { + parent::__construct($message, $code, $previous); + $this->header = $header; + } + + /** + * Get the header string. + * + * @return string + */ + public function getHeader() { + return $this->header; + } +}