MAPIException::getDisplayMessage() - Code Metrics - grommunio/mapi-header-php - Measure and Improve Code Quality continuously with Scrutinizer

MAPIException::getDisplayMessage() D
last analyzed 2025-07-03 17:06 UTC

↳ Parent: MAPIException

Complexity

Conditions	21
Paths	21

Size

Total Lines	43
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	21
eloc	31
c	1
b	0
f	0
nc	21
nop	0
dl	0
loc	43
rs	4.1666

How to fix Complexity

<?php
/*
 * SPDX-License-Identifier: AGPL-3.0-only
 * SPDX-FileCopyrightText: Copyright 2005-2016 Zarafa Deutschland GmbH
 * SPDX-FileCopyrightText: Copyright 2020-2024 grommunio GmbH
 */

/**
 * MAPIException
 * if enabled using mapi_enable_exceptions then php-ext can throw exceptions when
 * any error occurs in mapi calls. this exception will only be thrown when severity bit is set in
 * error code that means it will be thrown only for mapi errors not for mapi warnings.
 */
class MAPIException extends BaseException {
	/**
	 * Returns display message of exception if its set by the callee.
	 * If it is not set then we are generating some default display messages based
	 * on mapi error code.
	 *
	 */
	public function getDisplayMessage(): string {
		if (!empty($this->displayMessage)) {
			return $this->displayMessage;
		}

		switch ($this->getCode()) {
			/* see also class.webappauthentication.php:getErrorMessage for more instances */

			case MAPI_E_NO_ACCESS:
				return dgettext("zarafa", "You have insufficient privileges to open this object.");

			case ecUnknownUser:
			case MAPI_E_LOGON_FAILED:
			case MAPI_E_UNCONFIGURED:
				return dgettext("zarafa", "Logon Failed. Please check your name/password.");

			case MAPI_E_NETWORK_ERROR:
				return dgettext("zarafa", "Can not connect to Gromox.");

			case MAPI_E_UNKNOWN_ENTRYID:
				return dgettext("zarafa", "Can not open object with provided id.");

			case MAPI_E_NO_RECIPIENTS:
				return dgettext("zarafa", "There are no recipients in the message.");

			case MAPI_E_NOT_FOUND:
				return dgettext("zarafa", "Can not find object.");

			case MAPI_E_NOT_ENOUGH_MEMORY:
				return dgettext("zarafa", "Operation failed: Server does not have enough memory.");

			case MAPI_E_INTERFACE_NOT_SUPPORTED:
			case MAPI_E_INVALID_PARAMETER:
			case MAPI_E_INVALID_ENTRYID:
			case MAPI_E_INVALID_OBJECT:
			case MAPI_E_TOO_COMPLEX:
			case MAPI_E_CORRUPT_DATA:
			case MAPI_E_END_OF_SESSION:
			case MAPI_E_AMBIGUOUS_RECIP:
			case MAPI_E_COLLISION:
			case MAPI_E_UNCONFIGURED:
			default:
				return sprintf(dgettext("zarafa", "Unknown MAPI Error: %s"), get_mapi_error_name($this->getCode()));
		}
	}
}

// Tell the PHP extension which exception class to instantiate
if (function_exists('mapi_enable_exceptions')) {
	mapi_enable_exceptions("mapiexception");
}


1			<?php
2			/*
3			* SPDX-License-Identifier: AGPL-3.0-only
4			* SPDX-FileCopyrightText: Copyright 2005-2016 Zarafa Deutschland GmbH
5			* SPDX-FileCopyrightText: Copyright 2020-2024 grommunio GmbH
6			*/
7
8			/**
9			* MAPIException
10			* if enabled using mapi_enable_exceptions then php-ext can throw exceptions when
11			* any error occurs in mapi calls. this exception will only be thrown when severity bit is set in
12			* error code that means it will be thrown only for mapi errors not for mapi warnings.
13			*/
14			class MAPIException extends BaseException {
15			/**
16			* Returns display message of exception if its set by the callee.
17			* If it is not set then we are generating some default display messages based
18			* on mapi error code.
19			*
20			*/
21			public function getDisplayMessage(): string {
22			if (!empty($this->displayMessage)) {
23			return $this->displayMessage;
24			}
25
26			switch ($this->getCode()) {
27			/* see also class.webappauthentication.php:getErrorMessage for more instances */
28
29			case MAPI_E_NO_ACCESS:
30			return dgettext("zarafa", "You have insufficient privileges to open this object.");
31
32			case ecUnknownUser:
33			case MAPI_E_LOGON_FAILED:
34			case MAPI_E_UNCONFIGURED:
35			return dgettext("zarafa", "Logon Failed. Please check your name/password.");
36
37			case MAPI_E_NETWORK_ERROR:
38			return dgettext("zarafa", "Can not connect to Gromox.");
39
40			case MAPI_E_UNKNOWN_ENTRYID:
41			return dgettext("zarafa", "Can not open object with provided id.");
42
43			case MAPI_E_NO_RECIPIENTS:
44			return dgettext("zarafa", "There are no recipients in the message.");
45
46			case MAPI_E_NOT_FOUND:
47			return dgettext("zarafa", "Can not find object.");
48
49			case MAPI_E_NOT_ENOUGH_MEMORY:
50			return dgettext("zarafa", "Operation failed: Server does not have enough memory.");
51
52			case MAPI_E_INTERFACE_NOT_SUPPORTED:
53			case MAPI_E_INVALID_PARAMETER:
54			case MAPI_E_INVALID_ENTRYID:
55			case MAPI_E_INVALID_OBJECT:
56			case MAPI_E_TOO_COMPLEX:
57			case MAPI_E_CORRUPT_DATA:
58			case MAPI_E_END_OF_SESSION:
59			case MAPI_E_AMBIGUOUS_RECIP:
60			case MAPI_E_COLLISION:
61			case MAPI_E_UNCONFIGURED:
62			default:
63			return sprintf(dgettext("zarafa", "Unknown MAPI Error: %s"), get_mapi_error_name($this->getCode()));
64			}
65			}
66			}
67
68			// Tell the PHP extension which exception class to instantiate
69			if (function_exists('mapi_enable_exceptions')) {
70			mapi_enable_exceptions("mapiexception");
71			}
72

grommunio / mapi-header-php

MAPIException::getDisplayMessage() D last analyzed 2025-07-03 17:06 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

MAPIException::getDisplayMessage() D
last analyzed 2025-07-03 17:06 UTC