]> git.mxchange.org Git - core.git/blobdiff - inc/classes/main/class_BaseFrameworkSystem.php
Some 'static' array elements rewritten to constant, other cleanups
[core.git] / inc / classes / main / class_BaseFrameworkSystem.php
index 7a43629c0abf8dc23034e7b64f7bee5dab8d63d4..bdc442eee3ad0b3ea47207a2eed6ff01bf56ea44 100644 (file)
@@ -26,127 +26,137 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Instance of a request class
         */
-       private $requestInstance = null;
+       private $requestInstance = NULL;
 
        /**
         * Instance of a response class
         */
-       private $responseInstance = null;
+       private $responseInstance = NULL;
 
        /**
         * Search criteria instance
         */
-       private $searchInstance = null;
+       private $searchInstance = NULL;
 
        /**
         * Update criteria instance
         */
-       private $updateInstance = null;
+       private $updateInstance = NULL;
 
        /**
         * The file I/O instance for the template loader
         */
-       private $fileIoInstance = null;
+       private $fileIoInstance = NULL;
 
        /**
         * Resolver instance
         */
-       private $resolverInstance = null;
+       private $resolverInstance = NULL;
 
        /**
         * Template engine instance
         */
-       private $templateInstance = null;
+       private $templateInstance = NULL;
 
        /**
         * Database result instance
         */
-       private $resultInstance = null;
+       private $resultInstance = NULL;
 
        /**
         * Instance for user class
         */
-       private $userInstance = null;
+       private $userInstance = NULL;
 
        /**
         * A controller instance
         */
-       private $controllerInstance = null;
+       private $controllerInstance = NULL;
 
        /**
         * Instance of a RNG
         */
-       private $rngInstance = null;
+       private $rngInstance = NULL;
 
        /**
         * Instance of a crypto helper
         */
-       private $cryptoInstance = null;
+       private $cryptoInstance = NULL;
 
        /**
         * Instance of an Iterator class
         */
-       private $iteratorInstance = null;
+       private $iteratorInstance = NULL;
 
        /**
         * Instance of the list
         */
-       private $listInstance = null;
+       private $listInstance = NULL;
 
        /**
         * Instance of a menu
         */
-       private $menuInstance = null;
+       private $menuInstance = NULL;
 
        /**
         * Instance of the image
         */
-       private $imageInstance = null;
+       private $imageInstance = NULL;
 
        /**
         * Instance of the stacker
         */
-       private $stackerInstance = null;
+       private $stackerInstance = NULL;
 
        /**
         * A Compressor instance
         */
-       private $compressorInstance = null;
+       private $compressorInstance = NULL;
 
        /**
         * A Parseable instance
         */
-       private $parserInstance = null;
+       private $parserInstance = NULL;
 
        /**
         * A ProtocolHandler instance
         */
-       private $protocolInstance = null;
+       private $protocolInstance = NULL;
 
        /**
         * A database wrapper instance
         */
-       private $databaseInstance = null;
+       private $databaseInstance = NULL;
 
        /**
         * A helper instance for the form
         */
-       private $helperInstance = null;
+       private $helperInstance = NULL;
 
        /**
         * An instance of a Sourceable class
         */
-       private $sourceInstance = null;
+       private $sourceInstance = NULL;
 
        /**
         * An instance of a InputStreamable class
         */
-       private $inputStreamInstance = null;
+       private $inputStreamInstance = NULL;
 
        /**
         * An instance of a OutputStreamable class
         */
-       private $outputStreamInstance = null;
+       private $outputStreamInstance = NULL;
+
+       /**
+        * Networkable handler instance
+        */
+       private $handlerInstance = NULL;
+
+       /**
+        * Visitor handler instance
+        */
+       private $visitorInstance = NULL;
 
        /**
         * The real class name
@@ -156,7 +166,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * An instance of a database wrapper class
         */
-       private $wrapperInstance = null;
+       private $wrapperInstance = NULL;
 
        /**
         * Thousands seperator
@@ -579,24 +589,24 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Setter for database instance
         *
-        * @param               $dbInstance     The instance for the database connection (forced DatabaseConnection)
+        * @param               $databaseInstance       The instance for the database connection (forced DatabaseConnection)
         * @return      void
         */
-       public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
-               Registry::getRegistry()->addInstance('db_instance', $dbInstance);
+       public final function setDatabaseInstance (DatabaseConnection $databaseInstance) {
+               Registry::getRegistry()->addInstance('db_instance', $databaseInstance);
        }
 
        /**
         * Getter for database layer
         *
-        * @return      $dbInstance     The database layer instance
+        * @return      $databaseInstance       The database layer instance
         */
        public final function getDatabaseInstance () {
                // Get instance
-               $dbInstance = Registry::getRegistry()->getInstance('db_instance');
+               $databaseInstance = Registry::getRegistry()->getInstance('db_instance');
 
                // Return instance
-               return $dbInstance;
+               return $databaseInstance;
        }
 
        /**
@@ -816,7 +826,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @throws              NullPointerException    If the discovered application
         *                                                                              instance is still null
         */
-       protected function prepareTemplateInstance (ManageableApplication $applicationInstance = null) {
+       protected function prepareTemplateInstance (ManageableApplication $applicationInstance = NULL) {
                // Is the application instance set?
                if (is_null($applicationInstance)) {
                        // Get the current instance
@@ -1160,7 +1170,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        public final function getField ($fieldName) {
                // Default field value
-               $fieldValue = null;
+               $fieldValue = NULL;
 
                // Get result instance
                $resultInstance = $this->getResultInstance();
@@ -1368,8 +1378,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        // Get current time and add idle time
                        $sleepUntil = $this->getMilliTime() + abs($milliSeconds) / 1000;
 
-                       // New PHP 5.1.0 function found
-                       $hasSlept = time_sleep_until($sleepUntil);
+                       // New PHP 5.1.0 function found, ignore errors
+                       $hasSlept = @time_sleep_until($sleepUntil);
                } else {
                        // My Sun Station doesn't have that function even with latest PHP
                        // package. :(
@@ -1500,7 +1510,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @param       $protocolInstance       An instance of an ProtocolHandler
         * @return      void
         */
-       public final function setProtocolInstance (ProtocolHandler $protocolInstance) {
+       public final function setProtocolInstance (ProtocolHandler $protocolInstance = NULL) {
                $this->protocolInstance = $protocolInstance;
        }
 
@@ -1580,6 +1590,15 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                $this->sourceInstance = $sourceInstance;
        }
 
+       /**
+        * Getter for a Sourceable instance
+        *
+        * @return      $sourceInstance The Sourceable instance
+        */
+       protected final function getSourceInstance () {
+               return $this->sourceInstance;
+       }
+
        /**
         * Getter for a InputStreamable instance
         *
@@ -1618,6 +1637,44 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                $this->outputStreamInstance = $outputStreamInstance;
        }
 
+       /**
+        * Setter for handler instance
+        *
+        * @param       $handlerInstance        A Networkable instance
+        * @return      void
+        */
+       protected final function setHandlerInstance (Networkable $handlerInstance) {
+               $this->handlerInstance = $handlerInstance;
+       }
+
+       /**
+        * Getter for handler instance
+        *
+        * @return      $handlerInstance        A Networkable instance
+        */
+       protected final function getHandlerInstance () {
+               return $this->handlerInstance;
+       }
+
+       /**
+        * Setter for visitor instance
+        *
+        * @param       $visitorInstance        A Visitor instance
+        * @return      void
+        */
+       protected final function setVisitorInstance (Visitor $visitorInstance) {
+               $this->visitorInstance = $visitorInstance;
+       }
+
+       /**
+        * Getter for visitor instance
+        *
+        * @return      $visitorInstance        A Visitor instance
+        */
+       protected final function getVisitorInstance () {
+               return $this->visitorInstance;
+       }
+
        /**
         * Setter for raw package Data
         *
@@ -1821,6 +1878,44 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                // Return it
                return $isBase64;
        }
+
+       /**
+        * "Getter" to get response/request type from analysis of the system.
+        *
+        * @return      $responseType   Analyzed response type
+        */
+       protected function getResponseTypeFromSystem () {
+               // Default is console
+               $responseType = 'console';
+
+               // Is 'HTTP_HOST' set?
+               if (isset($_SERVER['HTTP_HOST'])) {
+                       // Then it is a HTTP response/request
+                       $responseType = 'http';
+               } // END - if
+
+               // Return it
+               return $responseType;
+       }
+
+       /**
+        * Gets a cache key from Criteria instance
+        *
+        * @param       $criteriaInstance       An instance of a Criteria class
+        * @param       $onlyKeys                       Only use these keys for a cache key
+        * @return      $cacheKey                       A cache key suitable for lookup/storage purposes
+        */
+       protected function getCacheKeyByCriteria (Criteria $criteriaInstance, $onlyKeys = array()) {
+               // Generate it
+               $cacheKey = sprintf("%s@%s",
+                       $this->__toString(),
+                       $criteriaInstance->getCacheKey($onlyKeys)
+               );
+
+               // And return it
+               //* NOISY-DEBUG: */ $this->debugOutput($this->__toString() . ': cacheKey=' . $cacheKey);
+               return $cacheKey;
+       }
 }
 
 // [EOF]