BaseException::getTitle() - Code Metrics - grommunio/grommunio-web - Measure and Improve Code Quality continuously with Scrutinizer

BaseException::getTitle() A
last analyzed 2025-10-22 17:08 UTC

↳ Parent: BaseException

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	2
rs	10

<?php

/**
 * 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() - formatted 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;

	/**
	 * Flag to check if exception is already handled or not.
	 */
	public $isHandled = false;

	/**
	 * Flag for allow to exception details message or not.
	 */
	public $allowToShowDetailsMessage = false;

	/**
	 * The exception title to show as a message box title at client side.
	 */
	public $title;

	/**
	 * The notification type by which exception needs to be shown at client side.
	 */
	public $notificationType = "";

	/**
	 * Construct the exception.
	 *
	 * @param string $errorMessage
	 * @param int    $code
	 * @param string $displayMessage
	 */
	public function __construct($errorMessage, $code = 0, ?Exception $previous = null, public $displayMessage = null) {
		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 title of an exception that will be sent to the client side
	 * to show it to user.
	 *
	 * @param string $title title of an exception
	 */
	public function setTitle($title) {
		$this->title = $title;
	}

	/**
	 * @return string returns title that should be sent to client to display as a message box
	 *                title
	 */
	public function getTitle() {
		return $this->title;
	}

	/**
	 * 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;
	}

	/**
	 * Name of the class of exception.
	 *
	 * @return string
	 */
	public function getName() {
		return static::class;
	}

	/**
	 * Function sets a type of notification by which exception needs to be shown at client side.
	 *
	 * @param string $notificationType type of notification to show an exception
	 */
	public function setNotificationType($notificationType) {
		$this->notificationType = $notificationType;
	}

	/**
	 * @return string a type of notification to show an exception
	 */
	public function getNotifiactionType() {
		return $this->notificationType;
	}

	/**
	 * Function returns the JSON request as a string from the backtrace.
	 *
	 * @return string The JSON request as a string
	 */
	private function getJSONRequest() {
		$jsonrequest = false;
		foreach ($this->getTrace() as $frame) {
			if (in_array('JSONRequest', $frame)) {
				// If there are multiple requests, we print each one on a new line
				$jsonrequest = implode(PHP_EOL, $frame['args']);
			}
		}

		return $jsonrequest;

	}

	/**
	 * If allowToShowDetailsMessage is set, function will return a detailed error message
	 * with the MAPIException code, e.g. 'MAPI_E_NO_ACCESS', the JSONRequest and the backtrace as string.
	 *
	 * @return string returns details error message
	 */
	public function getDetailsMessage() {
		$request = $this->getJSONRequest();
		$message = 'MAPIException Code [' . get_mapi_error_name($this->getCode()) . ']' .

			PHP_EOL . PHP_EOL . 'MAPIException in ' . $this->getFile() . ':' . $this->getLine() .
			PHP_EOL . PHP_EOL . 'Request:' .
			PHP_EOL . PHP_EOL . $request === false ? _('Request is not available.') : $request .
			PHP_EOL . PHP_EOL . 'Stack trace:' .
			PHP_EOL . PHP_EOL . $this->getTraceAsString();

		return $this->allowToShowDetailsMessage ? $message : '';
	}
}


1			<?php
2
3			/**
4			* Defines a base exception class for all custom exceptions, so every exceptions that
5			* is thrown/caught by this application should extend this base class and make use of it.
6			*
7			* Some basic function of Exception class
8			* getMessage()- message of exception
9			* getCode() - code of exception
10			* getFile() - source filename
11			* getLine() - source line
12			* getTrace() - n array of the backtrace()
13			* getTraceAsString() - formatted string of trace
14			*/
15			class BaseException extends Exception {
16			/**
17			* Base name of the file, so we don't have to use static path of the file.
18			*/
19			private $baseFile;
20
21			/**
22			* Flag to check if exception is already handled or not.
23			*/
24			public $isHandled = false;
25
26			/**
27			* Flag for allow to exception details message or not.
28			*/
29			public $allowToShowDetailsMessage = false;
30
31			/**
32			* The exception title to show as a message box title at client side.
33			*/
34			public $title;
35
36			/**
37			* The notification type by which exception needs to be shown at client side.
38			*/
39			public $notificationType = "";
40
41			/**
42			* Construct the exception.
43			*
44			* @param string $errorMessage
45			* @param int $code
46			* @param string $displayMessage
47			*/
48			public function __construct($errorMessage, $code = 0, ?Exception $previous = null, public $displayMessage = null) {
49			parent::__construct($errorMessage, (int) $code, $previous);
50			}
51
52			/**
53			* @return string returns file name and line number combined where exception occurred
54			*/
55			public function getFileLine() {
56			return $this->getBaseFile() . ':' . $this->getLine();
57			}
58
59			/**
60			* @return string returns message that should be sent to client to display
61			*/
62			public function getDisplayMessage() {
63			if (!is_null($this->displayMessage)) {
			0 ignored issues – show introduced 2025-03-21 18:20 UTC by Report Bug Copy Issue Report The condition `is_null($this->displayMessage)` is always `false`. Loading history...
64			return $this->displayMessage;
65			}
66
67			return $this->getMessage();
68			}
69
70			/**
71			* Function sets display message of an exception that will be sent to the client side
72			* to show it to user.
73			*
74			* @param string $message display message
75			*/
76			public function setDisplayMessage($message) {
77			$this->displayMessage = $message;
78			}
79
80			/**
81			* Function sets title of an exception that will be sent to the client side
82			* to show it to user.
83			*
84			* @param string $title title of an exception
85			*/
86			public function setTitle($title) {
87			$this->title = $title;
88			}
89
90			/**
91			* @return string returns title that should be sent to client to display as a message box
92			* title
93			*/
94			public function getTitle() {
95			return $this->title;
96			}
97
98			/**
99			* Function sets a flag in exception class to indicate that exception is already handled
100			* so if it is caught again in the top level of function stack then we have to silently
101			* ignore it.
102			*/
103			public function setHandled() {
104			$this->isHandled = true;
105			}
106
107			/**
108			* @return string returns base path of the file where exception occurred
109			*/
110			public function getBaseFile() {
111			if (is_null($this->baseFile)) {
112			$this->baseFile = basename(parent::getFile());
113			}
114
115			return $this->baseFile;
116			}
117
118			/**
119			* Name of the class of exception.
120			*
121			* @return string
122			*/
123			public function getName() {
124			return static::class;
125			}
126
127			/**
128			* Function sets a type of notification by which exception needs to be shown at client side.
129			*
130			* @param string $notificationType type of notification to show an exception
131			*/
132			public function setNotificationType($notificationType) {
133			$this->notificationType = $notificationType;
134			}
135
136			/**
137			* @return string a type of notification to show an exception
138			*/
139			public function getNotifiactionType() {
140			return $this->notificationType;
141			}
142
143			/**
144			* Function returns the JSON request as a string from the backtrace.
145			*
146			* @return string The JSON request as a string
147			*/
148			private function getJSONRequest() {
149			$jsonrequest = false;
150			foreach ($this->getTrace() as $frame) {
151			if (in_array('JSONRequest', $frame)) {
152			// If there are multiple requests, we print each one on a new line
153			$jsonrequest = implode(PHP_EOL, $frame['args']);
154			}
155			}
156
157			return $jsonrequest;
			0 ignored issues – show Bug Best Practice introduced 2022-12-12 18:11 UTC by Report Bug Copy Issue Report The expression `return $jsonrequest` could also return `false` which is incompatible with the documented return type `string`. Did you maybe forget to handle an error condition? If the returned type also contains false, it is an indicator that maybe an error condition leading to the specific return statement remains unhandled. Loading history...
158			}
159
160			/**
161			* If allowToShowDetailsMessage is set, function will return a detailed error message
162			* with the MAPIException code, e.g. 'MAPI_E_NO_ACCESS', the JSONRequest and the backtrace as string.
163			*
164			* @return string returns details error message
165			*/
166			public function getDetailsMessage() {
167			$request = $this->getJSONRequest();
168			$message = 'MAPIException Code [' . get_mapi_error_name($this->getCode()) . ']' .
			0 ignored issues – show introduced 2022-05-28 23:59 UTC by Report Bug Copy Issue Report The condition `'MAPIException Code [' ....OL . $request === false` is always `false`. Loading history...
169			PHP_EOL . PHP_EOL . 'MAPIException in ' . $this->getFile() . ':' . $this->getLine() .
170			PHP_EOL . PHP_EOL . 'Request:' .
171			PHP_EOL . PHP_EOL . $request === false ? _('Request is not available.') : $request .
172			PHP_EOL . PHP_EOL . 'Stack trace:' .
173			PHP_EOL . PHP_EOL . $this->getTraceAsString();
174
175			return $this->allowToShowDetailsMessage ? $message : '';
176			}
177			}
178

grommunio / grommunio-web

BaseException::getTitle() A last analyzed 2025-10-22 17:08 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

BaseException::getTitle() A
last analyzed 2025-10-22 17:08 UTC