Merge pull request #6083 from kenjis/fix-docs-cookie

docs: add about setCookie() prefix details

Author: kenjis

system/HTTP/ResponseTrait.php

@@ -543,7 +543,7 @@ public function redirect(string $uri, string $method = 'auto', ?int $code = null
      * @param string              $expire   Cookie expiration time in seconds
      * @param string              $domain   Cookie domain (e.g.: '.yourdomain.com')
      * @param string              $path     Cookie path (default: '/')
-     * @param string              $prefix   Cookie name prefix
+     * @param string              $prefix   Cookie name prefix ('': the default prefix)
      * @param bool                $secure   Whether to only transfer cookies via SSL
      * @param bool                $httponly Whether only make the cookie accessible via HTTP (no javascript)
      * @param string|null         $samesite
@@ -618,6 +618,9 @@ public function hasCookie(string $name, ?string $value = null, string $prefix =
     /**
      * Returns the cookie
      *
+     * @param string $prefix Cookie prefix.
+     *                       '': the default prefix
+     *
      * @return Cookie|Cookie[]|null
      */
     public function getCookie(?string $name = null, string $prefix = '')

system/Helpers/cookie_helper.php

@@ -29,7 +29,7 @@
      * @param string       $expire   The number of seconds until expiration
      * @param string       $domain   For site-wide cookie. Usually: .yourdomain.com
      * @param string       $path     The cookie path
-     * @param string       $prefix   The cookie prefix
+     * @param string       $prefix   The cookie prefix ('': the default prefix)
      * @param bool         $secure   True makes the cookie secure
      * @param bool         $httpOnly True makes the cookie accessible via http(s) only (no javascript)
      * @param string|null  $sameSite The cookie SameSite value

user_guide_src/source/helpers/cookie_helper.rst

@@ -28,7 +28,7 @@ The following functions are available:
     :param    int    $expire: Number of seconds until expiration
     :param    string    $domain: Cookie domain (usually: .yourdomain.com)
     :param    string    $path: Cookie path
-    :param    string    $prefix: Cookie name prefix
+    :param    string    $prefix: Cookie name prefix. If ``''``, the default from **app/Config/Cookie.php** is used
     :param    bool    $secure: Whether to only send the cookie through HTTPS
     :param    bool    $httpOnly: Whether to hide the cookie from JavaScript
     :param    string    $sameSite: The value for the SameSite cookie parameter. If ``null``, the default from **app/Config/Cookie.php** is used

user_guide_src/source/libraries/cookies/002.php

@@ -3,7 +3,7 @@
 use CodeIgniter\Cookie\Cookie;
 use Config\Cookie as CookieConfig;
 
-// pass in an Config\Cookie instance before constructing a Cookie class
+// pass in a Config\Cookie instance before constructing a Cookie class
 Cookie::setDefaults(new CookieConfig());
 $cookie = new Cookie('login_token');
 

user_guide_src/source/outgoing/response.rst

@@ -367,7 +367,7 @@ The methods provided by the parent class that are available are:
         :param int $expire: Cookie expiration time in seconds
         :param string $domain: Cookie domain
         :param string $path: Cookie path
-        :param string $prefix: Cookie name prefix
+        :param string $prefix: Cookie name prefix. If set to ``''``, the default value from **app/Config/Cookie.php** will be used
         :param bool $secure: Whether to only transfer the cookie through HTTPS
         :param bool $httponly: Whether to only make the cookie accessible for HTTP requests (no JavaScript)
         :param string $samesite: The value for the SameSite cookie parameter. If set to ``''``, no SameSite attribute will be set on the cookie. If set to ``null``, the default value from **app/Config/Cookie.php** will be used