Added a counter for all generated objects.
[core.git] / inc / classes / main / factories / class_BaseFactory.php
1 <?php
2 /**
3  * A general (base) factory
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.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 BaseFactory extends BaseFrameworkSystem {
25         /**
26          * Total objects generated
27          */
28         private static $total = 0;
29
30         /**
31          * Counter of all objects
32          */
33         private static $objectCounters = array();
34
35         /**
36          * Protected constructor
37          *
38          * @param       $className      Name of the real class (not BaseFactory)
39          * @return      void
40          */
41         protected function __construct ($className) {
42                 // Call parent constructor
43                 parent::__construct($className);
44         }
45
46         /**
47          * Count given object
48          *
49          * @param       $className      Name of the class we shall count
50          */
51         protected static final function countObject ($className) {
52                 // Count it up in total sum
53                 self::$total++;
54
55                 // Do we have an entry?
56                 if (!isset(self::$objectCounters[$className])) {
57                         // No, then generate one
58                         self::$objectCounters[$className] = 0;
59                 } // END - if
60
61                 // Count it up again
62                 //* NOISY-DEBUG: */ print __METHOD__.': className=' .$className . "\n";
63                 self::$objectCounters[$className]++;
64         }
65
66         /**
67          * Static getter for total object count
68          *
69          * @return      $total  Total amount of generated objects
70          */
71         public static final function getTotal () {
72                 return self::$total;
73         }
74
75         /**
76          * Static getter for all object counters
77          *
78          * @return      $objectCounters         An array with all object counters
79          */
80         public static final function getAllCounters () {
81                 return self::$objectCounters;
82         }
83 }
84
85 // [EOF]
86 ?>