Changeset 84 for trunk/lib/App.inc.php

Timestamp:

Apr 8, 2006 3:15:27 AM (18 years ago)

Author:

scdev

Message:

minor improvements

File:

• trunk/lib/App.inc.php (modified) (5 diffs)

trunk/lib/App.inc.php

@@ -343 +343 @@
 
     /**
-     * Add a message to the string globalmessage, which is printed in the header.
+     * Add a message to the session, which is printed in the header.
      * Just a simple way to print messages to the user.
      *
@@ -856 +856 @@
     }
 
-    /**
-     * Redirects a user by calling the App::dieURL(). It will use:
-     * 1. the stored boomerang URL, it it exists
-     * 2. the referring URL, it it exists.
-     * 3. an empty string, which will force App::dieURL to use the default URL.
-     */
-    function dieBoomerangURL($id=null, $carry_args=null)
+    /*
+    * Redirects a user by calling App::dieURL(). It will use:
+    * 1. the stored boomerang URL, it it exists
+    * 2. a specified $default_url, it it exists
+    * 3. the referring URL, it it exists.
+    * 4. redirect_home_url configuration variable.
+    *
+    * @access   public
+    * @param    string  $id             Identifier for this script.
+    * @param    mixed   $carry_args     Additional arguments to carry in the URL automatically (see App::oHREF()).
+    * @param    string  $default_url    A default URL if there is not a valid specified boomerang URL.
+    * @return   bool                    False if the session is not running. No return otherwise.
+    * @author   Quinn Comendant <quinn@strangecode.com>
+    * @since    31 Mar 2006 19:17:00
+    */
+    function dieBoomerangURL($id=null, $carry_args=null, $default_url=null)
     {
         if (!isset($this) || !is_a($this, 'App') && !is_subclass_of($this, 'App')) {
@@ -883 +892 @@
             // Delete stored boomerang.
             $this->deleteBoomerangURL($id);
+        } else if (isset($default_url)) {
+            $url = $default_url;
+        }
         } else if (!refererIsMe()) {
             // Ensure that the redirecting page is not also the referrer.
@@ -893 +905 @@
         }
 
-
-        // A redirection will never happen immediatly twice.
+        // A redirection will never happen immediately twice.
         // Set the time so ensure this doesn't happen.
         $_SESSION[$this->app]['boomerang']['time'] = time();
@@ -916 +927 @@
             return false;
         }
-        // A redirection will never happen immediatly after setting the boomerangURL.
+        // A redirection will never happen immediately after setting the boomerangURL.
         // Set the time so ensure this doesn't happen. See App::validBoomerangURL for more.