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