Browse Source
Migrate HintException to OCP
Migrate HintException to OCP
Signed-off-by: Gary Kim <gary@garykim.dev>pull/26681/head
No known key found for this signature in database
GPG Key ID: 9349B59FB54594AC
60 changed files with 185 additions and 134 deletions
-
2apps/encryption/lib/Command/FixEncryptedVersion.php
-
2apps/federatedfilesharing/lib/AddressHandler.php
-
2apps/federatedfilesharing/lib/Controller/MountPublicLinkController.php
-
2apps/federatedfilesharing/lib/Controller/RequestHandlerController.php
-
6apps/federatedfilesharing/lib/FederatedShareProvider.php
-
6apps/federatedfilesharing/lib/Notifications.php
-
2apps/federatedfilesharing/lib/Notifier.php
-
11apps/federatedfilesharing/lib/OCM/CloudFederationProviderFiles.php
-
2apps/federatedfilesharing/tests/AddressHandlerTest.php
-
2apps/federatedfilesharing/tests/Controller/MountPublicLinkControllerTest.php
-
2apps/federation/lib/Controller/SettingsController.php
-
2apps/federation/lib/DbHandler.php
-
2apps/federation/lib/Middleware/AddServerMiddleware.php
-
2apps/federation/lib/TrustedServers.php
-
4apps/federation/tests/Controller/SettingsControllerTest.php
-
2apps/federation/tests/Middleware/AddServerMiddlewareTest.php
-
2apps/federation/tests/TrustedServersTest.php
-
4apps/files_sharing/lib/Controller/ShareController.php
-
6apps/provisioning_api/lib/Controller/UsersController.php
-
2apps/settings/lib/Controller/ChangePasswordController.php
-
2apps/sharebymail/lib/ShareByMailProvider.php
-
2apps/sharebymail/tests/ShareByMailProviderTest.php
-
2apps/user_ldap/lib/Access.php
-
4apps/user_ldap/lib/Controller/RenewPasswordController.php
-
2apps/user_ldap/tests/AccessTest.php
-
6apps/user_ldap/tests/User_LDAPTest.php
-
6core/Controller/LostController.php
-
2index.php
-
2lib/base.php
-
1lib/composer/composer/autoload_classmap.php
-
1lib/composer/composer/autoload_static.php
-
3lib/private/AppFramework/App.php
-
2lib/private/Config.php
-
2lib/private/DatabaseSetupException.php
-
71lib/private/HintException.php
-
1lib/private/Installer.php
-
2lib/private/Log/ExceptionSerializer.php
-
2lib/private/Log/Systemdlog.php
-
4lib/private/Memcache/Factory.php
-
2lib/private/Memcache/Memcached.php
-
2lib/private/Setup.php
-
2lib/private/Share20/Manager.php
-
1lib/private/Updater.php
-
2lib/private/User/Manager.php
-
4lib/private/legacy/OC_Hook.php
-
12lib/private/legacy/OC_Util.php
-
2lib/public/Encryption/Exceptions/GenericEncryptionException.php
-
2lib/public/Federation/Exceptions/ActionNotSupportedException.php
-
2lib/public/Federation/Exceptions/AuthenticationFailedException.php
-
2lib/public/Federation/Exceptions/BadRequestException.php
-
2lib/public/Federation/Exceptions/ProviderAlreadyExistsException.php
-
2lib/public/Federation/Exceptions/ProviderCouldNotAddShareException.php
-
2lib/public/Federation/Exceptions/ProviderDoesNotExistsException.php
-
2lib/public/Files/StorageNotAvailableException.php
-
82lib/public/HintException.php
-
2lib/public/Share/Exceptions/GenericShareException.php
-
2tests/Core/Controller/ChangePasswordControllerTest.php
-
2tests/lib/Memcache/FactoryTest.php
-
2tests/lib/Share20/ManagerTest.php
-
6tests/lib/User/DatabaseTest.php
@ -0,0 +1,82 @@ |
|||||
|
<?php |
||||
|
/** |
||||
|
* @copyright Copyright (c) 2016, ownCloud, Inc. |
||||
|
* |
||||
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de> |
||||
|
* @author Bart Visscher <bartv@thisnet.nl> |
||||
|
* @author Lukas Reschke <lukas@statuscode.ch> |
||||
|
* @author Michael Gapczynski <GapczynskiM@gmail.com> |
||||
|
* @author Thomas Müller <thomas.mueller@tmit.eu> |
||||
|
* |
||||
|
* @license AGPL-3.0 |
||||
|
* |
||||
|
* This code is free software: you can redistribute it and/or modify |
||||
|
* it under the terms of the GNU Affero General Public License, version 3, |
||||
|
* as published by the Free Software Foundation. |
||||
|
* |
||||
|
* This program 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 Affero General Public License for more details. |
||||
|
* |
||||
|
* You should have received a copy of the GNU Affero General Public License, version 3, |
||||
|
* along with this program. If not, see <http://www.gnu.org/licenses/> |
||||
|
* |
||||
|
*/ |
||||
|
namespace OCP; |
||||
|
|
||||
|
/** |
||||
|
* Class HintException |
||||
|
* |
||||
|
* An Exception class with the intention to be presented to the end user |
||||
|
* |
||||
|
* @package OCP |
||||
|
* @since 23.0.0 |
||||
|
*/ |
||||
|
class HintException extends \Exception { |
||||
|
private $hint; |
||||
|
|
||||
|
/** |
||||
|
* HintException constructor. |
||||
|
* |
||||
|
* @since 23.0.0 |
||||
|
* @param string $message The error message. It will be not revealed to the |
||||
|
* the user (unless the hint is empty) and thus |
||||
|
* should be not translated. |
||||
|
* @param string $hint A useful message that is presented to the end |
||||
|
* user. It should be translated, but must not |
||||
|
* contain sensitive data. |
||||
|
* @param int $code |
||||
|
* @param \Exception|null $previous |
||||
|
*/ |
||||
|
public function __construct($message, $hint = '', $code = 0, \Exception $previous = null) { |
||||
|
$this->hint = $hint; |
||||
|
parent::__construct($message, $code, $previous); |
||||
|
} |
||||
|
|
||||
|
/** |
||||
|
* Returns a string representation of this Exception that includes the error |
||||
|
* code, the message and the hint. |
||||
|
* |
||||
|
* @since 23.0.0 |
||||
|
* @return string |
||||
|
*/ |
||||
|
public function __toString(): string { |
||||
|
return __CLASS__ . ": [{$this->code}]: {$this->message} ({$this->hint})\n"; |
||||
|
} |
||||
|
|
||||
|
/** |
||||
|
* Returns the hint with the intention to be presented to the end user. If |
||||
|
* an empty hint was specified upon instatiation, the message is returned |
||||
|
* instead. |
||||
|
* |
||||
|
* @since 23.0.0 |
||||
|
* @return string |
||||
|
*/ |
||||
|
public function getHint(): string { |
||||
|
if (empty($this->hint)) { |
||||
|
return $this->message; |
||||
|
} |
||||
|
return $this->hint; |
||||
|
} |
||||
|
} |
||||
Write
Preview
Loading…
Cancel
Save
Reference in new issue