Changeset 152 for trunk/lib/Prefs.inc.php

Timestamp:

Jun 7, 2006 5:35:16 AM (18 years ago)

Author:

scdev

Message:

Q - In the middle of working on the Prefs and Cache instantiation mode...can't decide to use singleton pattern or global vars. Updated ImageThumb? to allow filenames with path elements such as 01/23/4567_file.jpg.

File:

• trunk/lib/Prefs.inc.php (modified) (9 diffs)

trunk/lib/Prefs.inc.php

@@ -14 +14 @@
 // Load preferences for the user's session.
 require_once 'codebase/lib/Prefs.inc.php';
-$prefs = new Prefs('bURB');
+$prefs =& Prefs::getInstance('my-namespace');
 $prefs->setParam(array(
-    'enable_db' => $auth->isLoggedIn(),
+    'persistent' => $auth->isLoggedIn(),
     'user_id' => $auth->get('user_id'),
 ));
@@ -37 +37 @@
     var $_ns;
 
-    // Configuration of this object.
+    // Configuration parameters for this object.
     var $_params = array(
         
-        // The current user_id for which to load/save preferences.
+        // Enable database storage. If this is false, all prefs will live only as long as the session.
+        'persistent' => false,
+        
+        // The current user_id for which to load/save persistent preferences.
         'user_id' => null,
         
-        // How long before we force a reload of the prefs data? 3600 = once every hour.
+        // How long before we force a reload of the persistent prefs data? 3600 = once every hour.
         'load_timeout' => 3600,
         
-        // Enable database storage.
-        'enable_db' => true,
-        
-        // Name of database table to store prefs.
+        // Name of database table to store persistent prefs.
         'db_table' => 'pref_tbl',
 
@@ -74 +74 @@
             $this->setParam(array('create_table' => $app->getParam('db_create_tables')));
         }
+    }
+
+    /**
+     * This method enforces the singleton pattern for this class.
+     *
+     * @return  object  Reference to the global Prefs object.
+     * @access  public
+     * @static
+     */
+    function &getInstance($namespace='')
+    {
+        static $instances = array();
+
+        if (!array_key_exists($namespace, $instances)) {
+            $instances[$namespace] = new Prefs($namespace);
+        }
+
+        return $instances[$namespace];
     }
 
@@ -167 +185 @@
      * This function determins what data is saved to the database. Ensure clean values!
      *
-     * @param  string $key       The name of the preference to modify.
-     * @param  string $val       The new value for this preference.
+     * @param  string $key          The name of the preference to modify.
+     * @param  string $val          The new value for this preference.
+     * @param  bool   $persistent   Save this value forever? Set to false and value will exist as long as the session is in use.
      */
     function set($key, $val)
     {
         $app =& App::getInstance();
+
         if ('' == $key) {
             $app->logMsg(sprintf('Key is empty (provided with value: %s)', $val), LOG_NOTICE, __FILE__, __LINE__);
             return false;
         }
+        
         if (!isset($_SESSION[$this->_ns]['defaults'][$key]) || $_SESSION[$this->_ns]['defaults'][$key] != $val || isset($_SESSION[$this->_ns]['persistent'][$key])) {
             $_SESSION[$this->_ns]['persistent'][$key] = $val;            
@@ -193 +214 @@
     {
         $app =& App::getInstance();
-        if (isset($_SESSION[$this->_ns]['persistent'][$key])) {
+        if (array_key_exists($key, $_SESSION[$this->_ns]['persistent'])) {
             return $_SESSION[$this->_ns]['persistent'][$key];
-        } else if (isset($_SESSION[$this->_ns]['defaults'][$key])) {
+        } else if (array_key_exists($key, $_SESSION[$this->_ns]['defaults'])) {
             return $_SESSION[$this->_ns]['defaults'][$key];
         } else {
-            $app->logMsg(sprintf('Key not defined in default or persistent prefs cache: %s', $key), LOG_NOTICE, __FILE__, __LINE__);
+            $app->logMsg(sprintf('Key not found in prefs cache: %s', $key), LOG_NOTICE, __FILE__, __LINE__);
             return null;
         }
@@ -204 +225 @@
 
     /**
-     * To see if a persistent preference has been set.
+     * To see if a preference has been set.
      *
      * @param string $key       The name of the preference to check.
@@ -211 +232 @@
     function exists($key)
     {
-        return isset($_SESSION[$this->_ns]['persistent'][$key]);
+        return array_key_exists($key, $_SESSION[$this->_ns]['persistent']);
     }
 
@@ -254 +275 @@
         
         // Skip this method if not using the db.
-        if (true !== $this->getParam('enable_db')) {
+        if (true !== $this->getParam('persistent')) {
             return true;
         }
@@ -332 +353 @@
         
         // Skip this method if not using the db.
-        if (true !== $this->getParam('enable_db')) {
+        if (true !== $this->getParam('persistent')) {
             return true;
         }