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