Skip to content

Commit 3eb0ea4

Browse files
authored
Merge pull request #6463 from kenjis/deprecate-Cookie-withNeverExpiring
docs: deprecate Cookie::withNeverExpiring()
2 parents 3ba1eb5 + dcd4ab9 commit 3eb0ea4

File tree

4 files changed

+7
-3
lines changed

4 files changed

+7
-3
lines changed

system/Cookie/CloneableCookieInterface.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ public function withExpired();
6060
* Creates a new Cookie that will virtually never expire from the browser.
6161
*
6262
* @return static
63+
*
64+
* @deprecated See https://github.com/codeigniter4/CodeIgniter4/pull/6413
6365
*/
6466
public function withNeverExpiring();
6567

system/Cookie/Cookie.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,7 @@ public function withExpired()
460460
}
461461

462462
/**
463-
* {@inheritDoc}
463+
* @deprecated See https://github.com/codeigniter4/CodeIgniter4/pull/6413
464464
*/
465465
public function withNeverExpiring()
466466
{

user_guide_src/source/changelogs/v4.2.6.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ none.
2727
Deprecations
2828
************
2929

30-
none.
30+
- :php:meth:`CodeIgniter\\Cookie\\Cookie::withNeverExpiring()` is deprecated.
3131

3232
Bugs Fixed
3333
**********

user_guide_src/source/libraries/cookies.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ In runtime, you can manually supply a new default using the ``Cookie::setDefault
223223
Class Reference
224224
***************
225225

226-
.. php:namespace:: CodeIgniter\HTTP\Cookie
226+
.. php:namespace:: CodeIgniter\Cookie
227227
228228
.. php:class:: Cookie
229229
@@ -326,6 +326,8 @@ Class Reference
326326

327327
.. php:method:: withNeverExpiring()
328328
329+
.. important:: This method is deprecated.
330+
329331
:param string $name:
330332
:rtype: ``Cookie``
331333
:returns: new ``Cookie`` instance

0 commit comments

Comments
 (0)