inc/main/classes/factories/logger/class_LoggerFactory.php

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