| Path : /usr/share/kopano/php/mapi/ |
|
B-Con CMD Config cPanel C-Rdp D-Log Info Jump Mass Ransom Symlink vHost Zone-H |
| Current File : //usr/share/kopano/php/mapi/class.baseexception.php |
<?php
/*
* SPDX-License-Identifier: AGPL-3.0-only
* Copyright 2005 - 2016 Zarafa and its licensors
*/
/**
* Defines a base exception class for all custom exceptions, so every exceptions that
* is thrown/caught by this application should extend this base class and make use of it.
*
* Some basic function of Exception class
* getMessage()- message of exception
* getCode() - code of exception
* getFile() - source filename
* getLine() - source line
* getTrace() - n array of the backtrace()
* getTraceAsString() - formated string of trace
*/
class BaseException extends Exception {
/**
* Base name of the file, so we don't have to use static path of the file
*/
private $baseFile = null;
/**
* Flag to check if exception is already handled or not
*/
public $isHandled = false;
/**
* The exception message to show at client side.
*/
public $displayMessage = null;
/**
* @param string $errorMessage
* @param int $code
* @param Exception $previous
* @param string $displayMessage
* @return void
*/
public function __construct($errorMessage, $code = 0, Exception $previous = null, $displayMessage = null) {
// assign display message
$this->displayMessage = $displayMessage;
parent::__construct($errorMessage, (int) $code, $previous);
}
/**
* @return string returns file name and line number combined where exception occurred.
*/
public function getFileLine()
{
return $this->getBaseFile() . ':' . $this->getLine();
}
/**
* @return string returns message that should be sent to client to display
*/
public function getDisplayMessage()
{
if(!is_null($this->displayMessage)) {
return $this->displayMessage;
}
return $this->getMessage();
}
/**
* Function sets display message of an exception that will be sent to the client side
* to show it to user.
* @param string $message display message.
*/
public function setDisplayMessage($message)
{
$this->displayMessage = $message;
}
/**
* Function sets a flag in exception class to indicate that exception is already handled
* so if it is caught again in the top level of function stack then we have to silently
* ignore it.
*/
public function setHandled()
{
$this->isHandled = true;
}
/**
* @return string returns base path of the file where exception occurred.
*/
public function getBaseFile()
{
if(is_null($this->baseFile)) {
$this->baseFile = basename(parent::getFile());
}
return $this->baseFile;
}
/**
* Function will check for PHP version if it is greater than 5.3 then we can use its default implementation
* otherwise we have to use our own implementation of chanining functionality.
*
* @return Exception returns previous exception
*/
public function _getPrevious()
{
if (version_compare(PHP_VERSION, '5.3.0', '<'))
return $this->_previous;
else
return parent::getPrevious();
}
/**
* String representation of the exception, also handles previous exception.
*
* @return string
*/
public function __toString()
{
if (version_compare(PHP_VERSION, '5.3.0', '<')) {
if (($e = $this->getPrevious()) !== null) {
return $e->__toString()
. "\n\nNext "
. parent::__toString();
}
}
return parent::__toString();
}
/**
* Name of the class of exception.
*
* @return string
*/
public function getName()
{
return get_class($this);
}
// @TODO getTrace and getTraceAsString
}