Renamed Registry -> GenericRegistry to make it clear that this registry does
[core.git] / framework / main / exceptions / auth / class_UserAuthorizationException.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\User\Auth;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Filter\Filterable;
7 use Org\Mxchange\CoreFramework\Generic\FrameworkException;
8
9 /**
10  * An exception thrown when authorization of the user has failed
11  *
12  * @author              Roland Haeder <webmaster@shipsimu.org>
13  * @version             0.0.0
14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15  * @license             GNU GPL 3.0 or any newer version
16  * @link                http://www.shipsimu.org
17  *
18  * This program is free software: you can redistribute it and/or modify
19  * it under the terms of the GNU General Public License as published by
20  * the Free Software Foundation, either version 3 of the License, or
21  * (at your option) any later version.
22  *
23  * This program is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
30  */
31 class UserAuthorizationException extends FrameworkException {
32         /**
33          * The super constructor for all exceptions
34          *
35          * @param       $filterInstance         An instance of the filter throwing this exception
36          * @param       $code                           Error code
37          * @return      void
38          */
39         public function __construct (Filterable $filterInstance, $code) {
40                 // Construct the message
41                 $message = sprintf('[%s:%d] Authorization has failed. Error code %s',
42                         $filterInstance->__toString(),
43                         $this->getLine(),
44                         $this->getHexCode($code)
45                 );
46
47                 // Call parent exception constructor
48                 parent::__construct($message, $code);
49         }
50
51 }