Type-hints fixed, header docs fixed, exceptions deprecated

[shipsimu.git] / inc / classes / main / class_BaseFrameworkSystem.php

diff --git a/inc/classes/main/class_BaseFrameworkSystem.php b/inc/classes/main/class_BaseFrameworkSystem.php
index 48d9e3a0eb405c0de8d70e00b42799270ac5e1ca..7a738d6b26f9584dd5053c9e4acf90db922a6c65 100644 (file)
--- a/inc/classes/main/class_BaseFrameworkSystem.php
+++ b/inc/classes/main/class_BaseFrameworkSystem.php
@@ -176,16 +176,17 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Private super constructor
         *
+        * @param       $className      Name of the class
         * @return      void
         */
-       protected function __construct ($class) {
+       protected function __construct ($className) {
                // Set real class
-               $this->setRealClass($class);
+               $this->setRealClass($className);
 
                // Initialize the class if the registry is there
                if ((class_exists('Registry')) && (Registry::isInitialized() === false)) {
                        $this->initInstance();
-               }
+               } // END - if
        }
 
        /**
@@ -201,7 +202,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                                $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerst&ouml;rt.<br />\n",
                                        __CLASS__, $this->__toString()
                                ));
-                       }
+                       } // END - if
 
                        // Destroy all informations about this class but keep some text about it alive
                        $this->setObjectDescription(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
@@ -270,6 +271,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        $argsString = sprintf("!INVALID:%s!", $args);
                }
 
+               // Output stub message
                $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
                        $this->__toString(),
                        $methodName,
@@ -687,10 +689,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Validate if given object is the same as current
         *
-        * @param               $object An object instance for comparison with this class
+        * @param       $object An object instance for comparison with this class
         * @return      boolean The result of comparing both's unique ID
         */
-       public final function equals ($object) {
+       public final function equals (FrameworkInterface $object) {
                return ($this->getUniqueID() == $object->getUniqueID());
        }
 
@@ -698,8 +700,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * Compare if both simulation part description and class name matches
         * (shall be enougth)
         *
-        * @param               $itemInstance   An object instance to an other class
-        * @return      boolean         The result of comparing class name simulation part description
+        * @param       $itemInstance   An object instance to an other class
+        * @return      boolean                 The result of comparing class name simulation part description
         */
        public function itemMatches ($itemInstance) {
                return (
@@ -714,11 +716,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Compare class name of this and given class name
         *
-        * @param               $class  The class name as string from the other class
+        * @param               $className      The class name as string from the other class
         * @return      boolean The result of comparing both class names
         */
-       public final function isClass ($class) {
-               return ($this->__toString() == $class);
+       public final function isClass ($className) {
+               return ($this->__toString() == $className);
        }
 
        /**