Changeset 2257 for branches

Timestamp:

11/26/10 15:59:51 (18 months ago)

Author:

petsagouris

Message:

[Branch 1.5] Improved the class structure. (way of work)
Made methods private.

Files:

• branches/1.5/libs/Initialize.php (modified) (9 diffs)

branches/1.5/libs/Initialize.php

@@ -24 +24 @@
  * @link      http://www.hotarucms.org/
  */
-class Initialize {
+class Initialize
+{
 
         public $db;  // database object
         public $cage;   // Inspekt object
-        public $isDebug = false; // show db queries and page loading time
+        public $isDebug = FALSE; // show db queries and page loading time
 
         /**
          * Initialize Hotaru with the essentials
+         * 
+         * @return Initialize
          */
         public function __construct(Hotaru $h)
         {
-
-                // session to be used by CSRF, etc.
+                // Start the session
+                $this->initSession();
+
+                // The order here is important!
+                $this->setDefaultTimezone();
+                $this->setTableConstants();
+
+                $this->MakeCacheFolders();
+                $this->getFiles();
+                $this->initInspektCage();
+                $this->initDatabase();
+
+                $this->errorReporting();
+
+                $this->readSettings();
+                $this->setUpDatabaseCache();
+                $this->checkDebug();
+
+                $this->setUpJsConstants();
+
+                return $this;
+        }
+
+        /**
+         * Initialize the current session
+         *
+         * @return null
+         */
+        private function initSession()
+        {
+                // Session to be used by CSRF, etc.
                 if (!isset($_SESSION['HotaruCMS'])) {
                         session_start();
                         $_SESSION['HotaruCMS'] = time();
                 }
-
-                // The order here is important!
-                $this->setDefaultTimezone();
-                $this->setTableConstants();
-
-                $this->MakeCacheFolders();
-                $this->getFiles();
-                $this->cage = $this->initInspektCage();
-                $this->db = $this->initDatabase();
-
-                $this->errorReporting();
-
-                $this->readSettings();
-                $this->setUpDatabaseCache();
-                $this->isDebug = $this->checkDebug();
-
-                $this->setUpJsConstants();
-
-                return $this;
         }
 
         /**
          * Error reporting
-         */
-        public function errorReporting()
+         *
+         * @return null
+         */
+        private function errorReporting()
         {
                 // display errors
@@ -90 +105 @@
         /**
          * Table Constants
-         */
-        public function setTableConstants()
+         *
+         * @return null
+         */
+        private function setTableConstants()
         {
                 // define database tables
@@ -124 +141 @@
         }
 
-
         /**
          * Set the timezone
-         */
-        public function setDefaultTimezone()
+         *
+         * @return null
+         */
+        private function setDefaultTimezone()
         {
                 // set timezone
@@ -138 +156 @@
         /**
          * Include necessary files
-         */
-        public function getFiles()
+         *
+         * @return null
+         */
+        private function getFiles()
         {
                 require_once(FUNCTIONS.'funcs.strings.php');
@@ -151 +171 @@
          * Initialize Database
          *
-         * @return object
-         */
-        public function initDatabase()
-        {
-                $ezSQL = new Database(DB_USER, DB_PASSWORD, DB_NAME, DB_HOST);
-                $ezSQL->query("SET NAMES 'utf8'");
-
-                return $ezSQL;
+         * @return null
+         */
+        private function initDatabase()
+        {
+                $this->db = new Database(DB_USER, DB_PASSWORD, DB_NAME, DB_HOST);
+                $this->db->query("SET NAMES 'utf8'");
         }
 
@@ -164 +182 @@
          * Initialize Inspekt
          *
-         * @return object
-         */
-        public function initInspektCage()
-        {
-                $cage = Inspekt::makeSuperCage();
+         * @return null
+         */
+        private function initInspektCage()
+        {
+                $this->cage = Inspekt::makeSuperCage();
 
                 // Add Hotaru custom methods
-                $cage->addAccessor('testAlnumLines');
-                $cage->addAccessor('testPage');
-                $cage->addAccessor('testUsername');
-                $cage->addAccessor('testPassword');
-                $cage->addAccessor('getFriendlyUrl');
-                $cage->addAccessor('sanitizeAll');
-                $cage->addAccessor('sanitizeTags');
-                $cage->addAccessor('sanitizeEnts');
-                $cage->addAccessor('getHtmLawed');
-
-                return $cage;
+                $this->cage->addAccessor('testAlnumLines');
+                $this->cage->addAccessor('testPage');
+                $this->cage->addAccessor('testUsername');
+                $this->cage->addAccessor('testPassword');
+                $this->cage->addAccessor('getFriendlyUrl');
+                $this->cage->addAccessor('sanitizeAll');
+                $this->cage->addAccessor('sanitizeTags');
+                $this->cage->addAccessor('sanitizeEnts');
+                $this->cage->addAccessor('getHtmLawed');
         }
 
         /**
          * Returns all site settings
-         * @param <int> $siteid
-         *
-         * @return <bool>
-         */
-        public function readSettings()
+         *
+         * @return null
+         */
+        private function readSettings()
         {
                 $sql = "SELECT settings_name, settings_value FROM ".TABLE_SETTINGS;
@@ -196 +211 @@
 
                 if (!$settings) {
-                        return FALSE;
+                        return NULL;
                 }
 
@@ -207 +222 @@
 
                 if (!defined('THEME_URL')) {
-                        define('THEME_URL', SITEURL.'content/themes/'.THEME);
+                        define('THEME_URL', BASEURL.'content/themes/'.THEME);
                 }
 
                 if (!defined('ADMIN_THEME_URL')) {
-                        define('ADMIN_THEME_URL', SITEURL.'content/admin_themes/'.ADMIN_THEME);
-                }
-
-                return TRUE;
-        }
-
+                        define('ADMIN_THEME_URL', BASEURL.'content/admin_themes/'.ADMIN_THEME);
+                }
+        }
 
         /**
          * Make cache folders if they don't already exist
-         */
-        public function MakeCacheFolders()
-        {
-                // create a debug_logs folder if one doesn't exist.
-                if (!is_dir(CACHE . 'debug_logs')) { mkdir(CACHE . 'debug_logs'); }
-
-                // create a db_cache folder if one doesn't exist.
-                if (!is_dir(CACHE . 'db_cache')) { mkdir(CACHE . 'db_cache'); }
-
-                // create a css_js_cache folder if one doesn't exist.
-                if (!is_dir(CACHE . 'css_js_cache')) { mkdir(CACHE . 'css_js_cache'); }
-
-                // create a lang_cache folder if one doesn't exist.
-                if (!is_dir(CACHE . 'lang_cache')) { mkdir(CACHE . 'lang_cache'); }
-
-                // create an rss_cache folder if one doesn't exist.
-                if (!is_dir(CACHE . 'rss_cache')) { mkdir(CACHE . 'rss_cache'); }
-
-                // create an html_cache folder if one doesn't exist.
-                if (!is_dir(CACHE . 'html_cache')) { mkdir(CACHE . 'html_cache'); }
-        }
-
+         *
+         * @return null
+         */
+        private function MakeCacheFolders()
+        {
+                // Create the debug logs and database, css/js, lang, rss, html cache 
+                // directories if they dont exist.
+                foreach (array('debug_logs', 'db_cache', 'css_js_cache', 'lang_cache', 'rss_cache', 'html_cache') as $dir) {
+                        if (!is_dir(CACHE.$dir)) {
+                                mkdir(CACHE.$dir);
+                        }
+                }
+        }
 
         /**
@@ -247 +250 @@
          *
          * Note: Queries are still only cached following $this->db->cache_queries = true;
-         */
-        public function setUpDatabaseCache()
+         * 
+         * @return null
+         */
+        private function setUpDatabaseCache()
         {
                 // Setup database cache
                 $this->db->cache_timeout = DB_CACHE_DURATION; // Note: this is hours
                 $this->db->cache_dir = CACHE.'db_cache';
-                return $this->db->use_disk_cache = (bool) (DB_CACHE == "true");
-        }
-
-        /**
-         * Debug timer
-         *
-         * @ return bool
-         */
-        public function checkDebug()
-        {
-                // Start timer if debugging
+                $this->db->use_disk_cache = (bool) (DB_CACHE == "true");
+        }
+
+        /**
+         * Debug and timer
+         *
+         * @ return null
+         */
+        private function checkDebug()
+        {
+                // Show errors if we are debugging
                 if (DEBUG == 'false') {
-                        ini_set('display_errors', 0); // hide errors
-                        return FALSE;
-                }
-
+                        ini_set('display_errors', 0);
+                        $this->isDebug = FALSE;
+                }
+                
+                // Start timer if we are debugging
                 timer_start();
                 ini_set('display_errors', 1); // show errors
-
-                return TRUE;
-        }
-
-        /**
-         * Get JQuery Globals
-         *
-         *
-         */
-        public function setUpJsConstants()
+                $this->isDebug = TRUE;
+        }
+
+        /**
+         * Get JQuery Globals in a file.
+         *
+         * @return null
+         */
+        private function setUpJsConstants()
         {
                 $file = CACHE.'css_js_cache/JavascriptConstants.js';
                 if (!file_exists($file)) {
-                        file_put_contents($file, "var BASE='".BASE."', BASEURL='".SITEURL."', SITEURL='".SITEURL."', ADMIN_THEME='".ADMIN_THEME."', THEME='".THEME."', THEME_URL='".THEME_URL."', ADMIN_THEME_URL='".ADMIN_THEME_URL."';");
+                        file_put_contents($file, "var BASE='".BASE."', BASEURL='".BASEURL."', SITEURL='".SITEURL."', ADMIN_THEME='".ADMIN_THEME."', THEME='".THEME."', THEME_URL='".THEME_URL."', ADMIN_THEME_URL='".ADMIN_THEME_URL."';");
+                        return TRUE;
                 }
                 return FALSE;