more 'final' statements added

[shipsimu.git] / application / ship-simu / main / personell / class_SimulatorPersonell.php

diff --git a/application/ship-simu/main/personell/class_SimulatorPersonell.php b/application/ship-simu/main/personell/class_SimulatorPersonell.php
index 8581536f87e68abfc9998c9274534f54dceb8215..1d148ddb69d85809946e214177370e006cf6ea8a 100644 (file)
--- a/application/ship-simu/main/personell/class_SimulatorPersonell.php
+++ b/application/ship-simu/main/personell/class_SimulatorPersonell.php
@@ -1,6 +1,26 @@
 <?php
-
-// Die Schiffsbesatzung
+/**
+ * The general simulator personell class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
 class SimulatorPersonell extends BasePersonell {
        // Personell list
        private $personellList = null;
@@ -17,7 +37,7 @@ class SimulatorPersonell extends BasePersonell {
         * @return      void
         */
        private function __construct () {
-               // Eltern-Konstruktor aufrufen
+               // Call parent constructor
                parent::constructor(__CLASS__);
 
                if (((defined('DEBUG_PERSONELL')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruktor erreicht.<br />\n",
@@ -55,19 +75,16 @@ class SimulatorPersonell extends BasePersonell {
         *
         * @param               $amountPersonell                Number of personell we shall
         *                                                              generate
-        * @return      $personellInstance              An instance of this object with a 
+        * @return      $personellInstance              An instance of this object with a
         *                                                              list of personells
         */
-       public static function createSimulatorPersonell ($amountPersonell) {
+       public final static function createSimulatorPersonell ($amountPersonell) {
                // Make sure only integer can pass
                $amountPersonell = (int) $amountPersonell;
 
                // Get a new instance
                $personellInstance = new SimulatorPersonell();
 
-               // Generate unique ID number
-               $personellInstance->createUniqueID();
-
                // Debug message
                if ((defined('DEBUG_PERSONELL')) || (defined('DEBUG_ALL'))) $personellInstance->getDebugInstance()->output(sprintf("[%s:%d] Es werden <strong>%d</strong> Personal bereitgestellt.<br />\n",
                        __CLASS__,
@@ -80,7 +97,7 @@ class SimulatorPersonell extends BasePersonell {
 
                // Create requested amount of personell
                for ($idx = 0; $idx < $amountPersonell; $idx++) {
-                       $personellInstance->addPersonell();
+                       $personellInstance->addRandomPersonell();
                }
 
                // Debug message
@@ -110,7 +127,7 @@ class SimulatorPersonell extends BasePersonell {
         * list from an existing database backend
         *
         * @param               $idNumber               The ID number (only right part) of the list
-        * @return      $personellInstance      An instance of 
+        * @return      $personellInstance      An instance of
         * @throws      InvalidIDFormatException                If the given id number
         *                                                                      $idNumber is invalid
         * @throws      NullPointerException            If a null pointer (instance)
@@ -201,7 +218,7 @@ class SimulatorPersonell extends BasePersonell {
        }
 
        // Add new personell object to our list
-       public function addPersonell () {
+       public function addRandomPersonell () {
                // Gender list...
                $genders = array('M', 'F');
 
@@ -286,7 +303,7 @@ class SimulatorPersonell extends BasePersonell {
         *
         * @return      $count  Amount of unemployed personell
         */
-       public function getAllUnemployed () {
+       public final function getAllUnemployed () {
                if ((defined('DEBUG_PERSONELL')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Es werden alle erwerbslosen Personen gesucht.<br />\n",
                        __CLASS__,
                        __LINE__
@@ -321,7 +338,7 @@ class SimulatorPersonell extends BasePersonell {
         * @param               $cacheList      The new cache list to set or null for initialization/reset
         * @return      void
         */
-       private function setAllCacheList (FrameworkArrayObject $cacheList = null) {
+       private final function setAllCacheList (FrameworkArrayObject $cacheList = null) {
                $this->cacheList = $cacheList;
        }
 
@@ -331,7 +348,7 @@ class SimulatorPersonell extends BasePersonell {
         * @param               $cacheCond      The new cache conditions to set
         * @return      void
         */
-       private function setCacheCond ($cacheCond) {
+       private final function setCacheCond ($cacheCond) {
                $this->cacheCond = (string) $cacheCond;
        }
 
@@ -379,7 +396,7 @@ class SimulatorPersonell extends BasePersonell {
         * @return      void
         */
        public function saveObjectToDatabase () {
-               // Get the database 
+               // Get the database
                $dbInstance = $this->getDatabaseInstance();
 
                // Prepare the limitation object. We just need the personellList array object.
@@ -397,7 +414,7 @@ class SimulatorPersonell extends BasePersonell {
         *
         * @return      $personellList          The list of all personells
         */
-       public function getPersonellList () {
+       public final function getPersonellList () {
                return $this->personellList;
        }