Changeset 481

Timestamp:

May 4, 2014 12:46:59 AM (10 years ago)

Author:

anonymous

Message:

Needed to move the initial this->clear() call back into the constructor.

File:

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

trunk/lib/Prefs.inc.php

@@ -29 +29 @@
  * @author  Quinn Comendant <quinn@strangecode.com>
  * @version 3.0
+ * @todo This class could really benefit from being refactored using the factory pattern, with backend storage mechanisms.
  *
  * Example of use (database storagetype):
@@ -59 +60 @@
     private $_params = array(
 
-        // Legacy parameter, superceeded by the 'storagetype' setting.
+        // Store preferences in one of the available storage mechanisms: session, cookie, database
+        // This default should remain set to 'session' for legacy support.
+        'storagetype' => 'session',
+
+        // This parameter is only used for legacy support, superceeded by the 'storagetype' setting.
         // Enable database storage. If this is false, all prefs will live only as long as the session.
         'persistent' => null,
 
-        // Store preferences in one of the available storage mechanisms: session, cookie, database
-        'storagetype' => 'session',
-
         // ----------------------------------------------------------
         // Cookie-type settings.
@@ -87 +89 @@
         'load_timeout' => 3600,
 
-        // Name of database table to store persistent prefs.
+        // Name of database table to store prefs.
         'db_table' => 'pref_tbl',
 
@@ -111 +113 @@
         // Optional initial params.
         $this->setParam($params);
+
+        // Initialized the prefs array.
+        if ('cookie' != $app->getParam('storagetype') && !isset($_SESSION['_prefs'][$this->_ns]['saved'])) {
+            $this->clear();
+        }
 
         // Run Prefs->save() upon script completion if we're using the database storagetype.
@@ -174 +181 @@
 
         // Convert the legacy param 'persistent' to 'storagetype=database'.
+        // Old sites would set 'persistent' to true (use database) or false (use sessions).
+        // If it is true, we set storagetype=database here.
+        // If false, we rely on the default, sessions (which is assigned in the params).
         if (isset($params['persistent']) && $params['persistent'] && !isset($params['storagetype'])) {
             $params['storagetype'] = 'database';
@@ -206 +216 @@
      * Sets the default values for preferences. If a preference is not explicitly
      * set, the value set here will be used. Can be called multiple times to merge additional
-     * defaults together. This is mostly only useful for the database storetype, when you have
+     * defaults together. This is mostly only useful for the database storagetype, when you have
      * values you want to use as default, and those are not stored to the database (so the defaults
      * can be changed later and apply to all users who haven't make s specific setting).
-     * For the cookie storetype, using setDefaults just sets cookies but only if a cookie with
+     * For the cookie storagetype, using setDefaults just sets cookies but only if a cookie with
      * the same name is not already set.
      *
@@ -267 +277 @@
         case 'session':
         case 'database':
-            // Initialized the prefs array.
-            if (!isset($_SESSION['_prefs'][$this->_ns]['saved'])) {
-                $this->clear();
-            }
             // Set a saved preference if...
             // - there isn't a default.