framework/main/classes/factories/class_BaseFactory.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Factory;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
   7
   8 /**
   9  * A general (base) factory
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13 <<<<<<< HEAD:framework/main/classes/factories/class_BaseFactory.php
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15 =======
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  17 >>>>>>> Some updates::inc/main/classes/factories/class_BaseFactory.php
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 abstract class BaseFactory extends BaseFrameworkSystem {
  35         /**
  36          * Total objects generated
  37          */
  38         private static $total = 0;
  39
  40         /**
  41          * Counter of all objects
  42          */
  43         private static $objectCounters = array();
  44
  45         /**
  46          * Protected constructor
  47          *
  48          * @param       $className      Name of the real class (not BaseFactory)
  49          * @return      void
  50          */
  51         protected function __construct ($className) {
  52                 // Call parent constructor
  53                 parent::__construct($className);
  54         }
  55
  56         /**
  57          * Count given object
  58          *
  59          * @param       $className      Name of the class we shall count
  60          */
  61         protected static final function countObject ($className) {
  62                 // Count it up in total sum
  63                 self::$total++;
  64
  65                 // Do we have an entry?
  66                 if (!isset(self::$objectCounters[$className])) {
  67                         // No, then generate one
  68                         self::$objectCounters[$className] = 0;
  69                 } // END - if
  70
  71                 // Count it up again
  72                 //* NOISY-DEBUG: */ print __METHOD__.': className=' .$className . PHP_EOL;
  73                 self::$objectCounters[$className]++;
  74         }
  75
  76         /**
  77          * Static getter for total object count
  78          *
  79          * @return      $total  Total amount of generated objects
  80          */
  81         public static final function getTotal () {
  82                 return self::$total;
  83         }
  84
  85         /**
  86          * Static getter for all object counters
  87          *
  88          * @return      $objectCounters         An array with all object counters
  89          */
  90         public static final function getAllCounters () {
  91                 return self::$objectCounters;
  92         }
  93
  94 }