framework/main/classes/factories/class_BaseFactory.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Factory;
   4
   5 // Import framework stuff
   6 use CoreFramework\Object\BaseFrameworkSystem;
   7
   8 /**
   9  * A general (base) 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 BaseFactory extends BaseFrameworkSystem {
  31         /**
  32          * Total objects generated
  33          */
  34         private static $total = 0;
  35
  36         /**
  37          * Counter of all objects
  38          */
  39         private static $objectCounters = array();
  40
  41         /**
  42          * Protected constructor
  43          *
  44          * @param       $className      Name of the real class (not BaseFactory)
  45          * @return      void
  46          */
  47         protected function __construct ($className) {
  48                 // Call parent constructor
  49                 parent::__construct($className);
  50         }
  51
  52         /**
  53          * Count given object
  54          *
  55          * @param       $className      Name of the class we shall count
  56          */
  57         protected static final function countObject ($className) {
  58                 // Count it up in total sum
  59                 self::$total++;
  60
  61                 // Do we have an entry?
  62                 if (!isset(self::$objectCounters[$className])) {
  63                         // No, then generate one
  64                         self::$objectCounters[$className] = 0;
  65                 } // END - if
  66
  67                 // Count it up again
  68                 //* NOISY-DEBUG: */ print __METHOD__.': className=' .$className . PHP_EOL;
  69                 self::$objectCounters[$className]++;
  70         }
  71
  72         /**
  73          * Static getter for total object count
  74          *
  75          * @return      $total  Total amount of generated objects
  76          */
  77         public static final function getTotal () {
  78                 return self::$total;
  79         }
  80
  81         /**
  82          * Static getter for all object counters
  83          *
  84          * @return      $objectCounters         An array with all object counters
  85          */
  86         public static final function getAllCounters () {
  87                 return self::$objectCounters;
  88         }
  89
  90 }