A much better name is HandleableProtocol.

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

diff --git a/inc/classes/main/class_BaseFrameworkSystem.php b/inc/classes/main/class_BaseFrameworkSystem.php
index 47282b389ad847ce13769c57fce125fb019a8386..07e9a2c682832585e18469648a6030dde0533565 100644 (file)
--- a/inc/classes/main/class_BaseFrameworkSystem.php
+++ b/inc/classes/main/class_BaseFrameworkSystem.php
@@ -5,7 +5,7 @@
  *
  * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.shipsimu.org
  *
@@ -23,6 +23,11 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
+       /**
+        * Length of output from hash()
+        */
+       private static $hashLength = NULL;
+
        /**
         * The real class name
         */
@@ -111,7 +116,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Instance of the stacker
         */
-       private $stackerInstance = NULL;
+       private $stackInstance = NULL;
 
        /**
         * A Compressor instance
@@ -124,7 +129,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        private $parserInstance = NULL;
 
        /**
-        * A ProtocolHandler instance
+        * A HandleableProtocol instance
         */
        private $protocolInstance = NULL;
 
@@ -178,6 +183,26 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        private $pointerInstance = NULL;
 
+       /**
+        * An instance of an Indexable class
+        */
+       private $indexInstance = NULL;
+
+       /**
+        * An instance of a Block class
+        */
+       private $blockInstance = NULL;
+
+       /**
+        * A Minable instance
+        */
+       private $minableInstance = NULL;
+
+       /**
+        * A FrameworkDirectory instance
+        */
+       private $directoryInstance = NULL;
+
        /**
         * Thousands separator
         */
@@ -203,11 +228,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        private $genericArray = array();
 
-       /**
-        * Length of output from hash()
-        */
-       private static $hashLength = NULL;
-
        /***********************
         * Exception codes.... *
         ***********************/
@@ -467,7 +487,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                $this->debugBackTrace(sprintf('Tried to set a missing field. name=%s, value[%s]=%s',
                        $name,
                        gettype($value),
-                       $value
+                       print_r($value, TRUE)
                ));
        }
 
@@ -943,20 +963,20 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Setter for stacker instance
         *
-        * @param       $stackerInstance        An instance of an stacker
+        * @param       $stackInstance  An instance of an stacker
         * @return      void
         */
-       public final function setStackerInstance (Stackable $stackerInstance) {
-               $this->stackerInstance = $stackerInstance;
+       public final function setStackInstance (Stackable $stackInstance) {
+               $this->stackInstance = $stackInstance;
        }
 
        /**
         * Getter for stacker instance
         *
-        * @return      $stackerInstance        An instance of an stacker
+        * @return      $stackInstance  An instance of an stacker
         */
-       public final function getStackerInstance () {
-               return $this->stackerInstance;
+       public final function getStackInstance () {
+               return $this->stackInstance;
        }
 
        /**
@@ -998,9 +1018,9 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        }
 
        /**
-        * Setter for ProtocolHandler instance
+        * Setter for HandleableProtocol instance
         *
-        * @param       $protocolInstance       An instance of an ProtocolHandler
+        * @param       $protocolInstance       An instance of an HandleableProtocol
         * @return      void
         */
        public final function setProtocolInstance (ProtocolHandler $protocolInstance = NULL) {
@@ -1008,9 +1028,9 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        }
 
        /**
-        * Getter for ProtocolHandler instance
+        * Getter for HandleableProtocol instance
         *
-        * @return      $protocolInstance       An instance of an ProtocolHandler
+        * @return      $protocolInstance       An instance of an HandleableProtocol
         */
        public final function getProtocolInstance () {
                return $this->protocolInstance;
@@ -1231,7 +1251,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Setter for InputOutputPointer instance
         *
-        * @param       $pointerInstance        An instance of an InputOutputPointer
+        * @param       $pointerInstance        An instance of an InputOutputPointer class
         * @return      void
         */
        protected final function setPointerInstance (InputOutputPointer $pointerInstance) {
@@ -1241,12 +1261,88 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Getter for InputOutputPointer instance
         *
-        * @return      $pointerInstance        An instance of an InputOutputPointer
+        * @return      $pointerInstance        An instance of an InputOutputPointer class
         */
        public final function getPointerInstance () {
                return $this->pointerInstance;
        }
 
+       /**
+        * Setter for Indexable instance
+        *
+        * @param       $indexInstance  An instance of an Indexable class
+        * @return      void
+        */
+       protected final function setIndexInstance (Indexable $indexInstance) {
+               $this->indexInstance = $indexInstance;
+       }
+
+       /**
+        * Getter for Indexable instance
+        *
+        * @return      $indexInstance  An instance of an Indexable class
+        */
+       public final function getIndexInstance () {
+               return $this->indexInstance;
+       }
+
+       /**
+        * Setter for Block instance
+        *
+        * @param       $blockInstance  An instance of an Block class
+        * @return      void
+        */
+       protected final function setBlockInstance (Block $blockInstance) {
+               $this->blockInstance = $blockInstance;
+       }
+
+       /**
+        * Getter for Block instance
+        *
+        * @return      $blockInstance  An instance of an Block class
+        */
+       public final function getBlockInstance () {
+               return $this->blockInstance;
+       }
+
+       /**
+        * Setter for Minable instance
+        *
+        * @param       $minableInstance        A Minable instance
+        * @return      void
+        */
+       protected final function setMinableInstance (Minable $minableInstance) {
+               $this->minableInstance = $minableInstance;
+       }
+
+       /**
+        * Getter for minable instance
+        *
+        * @return      $minableInstance        A Minable instance
+        */
+       protected final function getMinableInstance () {
+               return $this->minableInstance;
+       }
+
+       /**
+        * Setter for FrameworkDirectory instance
+        *
+        * @param       $directoryInstance      A FrameworkDirectoryPointer instance
+        * @return      void
+        */
+       protected final function setDirectoryInstance (FrameworkDirectory $directoryInstance) {
+               $this->directoryInstance = $directoryInstance;
+       }
+
+       /**
+        * Getter for FrameworkDirectory instance
+        *
+        * @return      $directoryInstance      A FrameworkDirectory instance
+        */
+       protected final function getDirectoryInstance () {
+               return $this->directoryInstance;
+       }
+
        /**
         * Checks whether an object equals this object. You should overwrite this
         * method to implement own equality checks