Changeset 786 for trunk

Timestamp:

Mar 14, 2023 7:01:46 PM (14 months ago)

Author:

anonymous

Message:

Fix App::unsetCookie() to match args to setCookie().

File:

• trunk/lib/App.inc.php (modified) (1 diff)

trunk/lib/App.inc.php

@@ -1837 +1837 @@
 
     /*
-    * Delete a cookie previously created by setCookie().
+    * Delete a cookie previously created by setCookie(). The same function arguments must be used to unset a cookie as were used to set it.
     *
     * @access   public
     * @param    string  $name       The name of the cookie.
+    * @param    string  $path       The path on the server in which the cookie will be available on.
+    * @param    string  $domain     The domain that the cookie is available to.
+    * @param    bool    $secure     Indicates that the cookie should only be transmitted over a secure HTTPS connection from the client.
+    * @param    bool    $httponly   When TRUE the cookie will be made accessible only through the HTTP protocol (makes cookies unreadable to javascript).
+    * @param    string  $samesite   Value of the SameSite key ('None', 'Lax', or 'Strict'). PHP 7.3+ only.
     * @return   bool                True on success, false on error.
     * @author   Quinn Comendant <quinn@strangecode.com>
     * @since    14 Mar 2023 12:12:15
     */
-    public function unsetCookie($name)
-    {
-        $ret = setcookie($name, '', 1);
-        if (false === $ret) {
-            $this->logMsg(sprintf('Failed to unset cookie (%s) probably due to output before headers.', $name), LOG_NOTICE, __FILE__, __LINE__);
-        }
-        return $ret;
+    public function unsetCookie($name, $path='/', $domain=null, $secure=null, $httponly=null, $samesite=null)
+    {
+        return $this->setCookie($name, '', 1, $path, $domain, $secure, $httponly, $samesite);
     }