Changeset 150

Timestamp:

Jun 5, 2006 3:05:39 AM (18 years ago)

Author:

scdev

Message:

Q - okay now finished with Prefs.inc.php; it is sweeeet!

File:

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

trunk/lib/Prefs.inc.php

@@ -9 +9 @@
  * @author  Quinn Comendant <quinn@strangecode.com>
  * @version 2.1
+ * 
+ * Example of use:
+---------------------------------------------------------------------
+// Load preferences for the user.
+require_once 'codebase/lib/Prefs.inc.php';
+$prefs = new Prefs('bURB');
+$prefs->setParam(array(
+    'enable_db' => $auth->isLoggedIn(),
+    'user_id' => $auth->get('user_id'),
+));
+$prefs->setDefaults(array(
+    'search_num_results' => 25,
+    'datalog_num_entries' => 25,
+));
+$prefs->load();
+---------------------------------------------------------------------
  */
 class Prefs {
@@ -44 +60 @@
         
         // Initialized the prefs array.
-        if (!isset($_SESSION[$this->_ns])) {
-            $_SESSION[$this->_ns] = array('loaded' => false, 'data' => array());
+        if (!isset($_SESSION[$this->_ns]['data'])) {
+            $this->clear();
         }
 
@@ -135 +151 @@
     function setDefaults($defaults)
     {
-        $app =& App::getInstance();
         if (isset($defaults) && is_array($defaults)) {
             // Apply defaults to the session, setting only non-existing values.
-            $app->logMsg(sprintf('Pre-defaulting: %s', getDump($_SESSION[$this->_ns]['data'])), LOG_DEBUG, __FILE__, __LINE__);
             $_SESSION[$this->_ns]['data'] = array_merge($defaults, $_SESSION[$this->_ns]['data']);
-            $app->logMsg(sprintf('Post-defaulting: %s', getDump($_SESSION[$this->_ns]['data'])), LOG_DEBUG, __FILE__, __LINE__);
         }
     }
@@ -197 +210 @@
     function clear()
     {
-        $_SESSION[$this->_ns] = array();
+        $_SESSION[$this->_ns] = array(
+            'loaded' => false,
+            'load_datetime' => '1970-01-01',
+            'data' => array()
+        );
     }
     
@@ -204 +221 @@
     *
     * @access   public
+    * @param    bool    $force  Set to always load from database, regardless if _isLoaded() or not.
     * @return   bool    True if loading succeeded.
     * @author   Quinn Comendant <quinn@strangecode.com>
@@ -209 +227 @@
     * @since    04 Jun 2006 16:56:53
     */
-    function load()
+    function load($force=false)
     {
         $app =& App::getInstance();
@@ -219 +237 @@
         }
 
+        $this->initDB();
+
         // Prefs already loaded for this session.
-        if ($this->_isLoaded()) {
+        if (!$force && $this->_isLoaded()) {
             return true;
         }
@@ -229 +249 @@
             return false;
         }
-
-        $this->initDB();
+        
+        // Clear existing cache.
+        $this->clear();
         
         // Retreive all prefs for this user and namespace.
@@ -243 +264 @@
             $_SESSION[$this->_ns]['data'][$key] = $val;
         }
+        
+        $app->logMsg(sprintf('%s prefs loaded from database.', sizeof($_SESSION[$this->_ns]['data'])), LOG_DEBUG, __FILE__, __LINE__);
         
         // Data loaded only once per session.