a0099eff83e44fcdebb70f24df6f361309ea6acb
[core.git] / framework / main / classes / factories / logger / class_LoggerFactory.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Logging;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Factory\BaseFactory;
7 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
8
9 /**
10  * A Logger factory
11  *
12  * @author              Roland Haeder <webmaster@shipsimu.org>
13  * @version             0.0.0
14 <<<<<<< HEAD:framework/main/classes/factories/logger/class_LoggerFactory.php
15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 =======
17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
18 >>>>>>> Some updates::inc/main/classes/factories/logger/class_LoggerFactory.php
19  * @license             GNU GPL 3.0 or any newer version
20  * @link                http://www.shipsimu.org
21  *
22  * This program is free software: you can redistribute it and/or modify
23  * it under the terms of the GNU General Public License as published by
24  * the Free Software Foundation, either version 3 of the License, or
25  * (at your option) any later version.
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30  * GNU General Public License for more details.
31  *
32  * You should have received a copy of the GNU General Public License
33  * along with this program. If not, see <http://www.gnu.org/licenses/>.
34  */
35 class LoggerFactory extends BaseFactory {
36         /**
37          * Protected constructor
38          *
39          * @return      void
40          */
41         protected function __construct () {
42                 // Call parent constructor
43                 parent::__construct(__CLASS__);
44         }
45
46         /**
47          * Creates a logger instance for given FrameworkInterface. This allows every
48          * class that implements FrameworkInterface to have an own logger. Surely
49          * this factory and the logger itself cannot have an own logger as this would
50          * lead to an endless loop: Get factory instance, get a logger for the factory
51          * instance which ivokes the factory's method again.
52          *
53          * @param       $objectInstance         An instance of a FrameworkInterface class
54          * @return      $loggerInstance         An instance of a Logger class
55          */
56         public static final function createLoggerInstance (FrameworkInterface $objectInstance) {
57                 // @TODO Unfinished work
58         }
59
60 }