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

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Logging;
   4
   5 // Import framework stuff
   6 use CoreFramework\Factory\BaseFactory;
   7 use CoreFramework\Generic\FrameworkInterface;
   8
   9 /**
  10  * A Logger factory
  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 LoggerFactory extends BaseFactory {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Creates a logger instance for given FrameworkInterface. This allows every
  44          * class that implements FrameworkInterface to have an own logger. Surely
  45          * this factory and the logger itself cannot have an own logger as this would
  46          * lead to an endless loop: Get factory instance, get a logger for the factory
  47          * instance which ivokes the factory's method again.
  48          *
  49          * @param       $objectInstance         An instance of a FrameworkInterface class
  50          * @return      $loggerInstance         An instance of a Logger class
  51          */
  52         public static final function createLoggerInstance (FrameworkInterface $objectInstance) {
  53                 // @TODO Unfinished work
  54         }
  55
  56 }