Skip to content

docs: deprecate Cookie::withNeverExpiring() #6463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 2, 2022
Merged

docs: deprecate Cookie::withNeverExpiring() #6463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6815794
docs: add @deprecated
kenjis Aug 31, 2022
1fe22d1
docs: fix namespace
kenjis Aug 31, 2022
97d1a51
docs: add deprecation of Cookie::withNeverExpiring()
kenjis Aug 31, 2022
dcd4ab9
docs: remove `@inheritDoc`
kenjis Sep 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions system/Cookie/CloneableCookieInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ public function withExpired();
* Creates a new Cookie that will virtually never expire from the browser.
*
* @return static
*
* @deprecated See https://github.com/codeigniter4/CodeIgniter4/pull/6413
*/
public function withNeverExpiring();

Expand Down
2 changes: 1 addition & 1 deletion system/Cookie/Cookie.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ public function withExpired()
}

/**
* {@inheritDoc}
* @deprecated See https://github.com/codeigniter4/CodeIgniter4/pull/6413
*/
public function withNeverExpiring()
{
Expand Down
2 changes: 1 addition & 1 deletion user_guide_src/source/changelogs/v4.2.6.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ none.
Deprecations
************

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

Bugs Fixed
**********
Expand Down
4 changes: 3 additions & 1 deletion user_guide_src/source/libraries/cookies.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ In runtime, you can manually supply a new default using the ``Cookie::setDefault
Class Reference
***************

.. php:namespace:: CodeIgniter\HTTP\Cookie
.. php:namespace:: CodeIgniter\Cookie

.. php:class:: Cookie

Expand Down Expand Up @@ -326,6 +326,8 @@ Class Reference

.. php:method:: withNeverExpiring()

.. important:: This method is deprecated.

:param string $name:
:rtype: ``Cookie``
:returns: new ``Cookie`` instance
Expand Down