Skip to content

[HttpFoundation] Document the Cookie::with*() methods #13224

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 1 commit into from
Feb 24, 2020
Merged

[HttpFoundation] Document the Cookie::with*() methods #13224

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions components/http_foundation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,9 +443,21 @@ method takes an instance of
You can clear a cookie via the
:method:`Symfony\\Component\\HttpFoundation\\ResponseHeaderBag::clearCookie` method.

Note you can create a
:class:`Symfony\\Component\\HttpFoundation\\Cookie` object from a raw header
value using :method:`Symfony\\Component\\HttpFoundation\\Cookie::fromString`.
In addition to the ``Cookie::create()`` method, you can create a ``Cookie``
object from a raw header value using :method:`Symfony\\Component\\HttpFoundation\\Cookie::fromString`.
You can also use the ``with*()`` methods to change some Cookie property (or to
build the entire Cookie using a fluent interface). Each ``with*()`` method returns
a new object with the modified property::

$cookie = Cookie::create('foo')
->withValue('bar')
->withExpiresTime(strtotime('Fri, 20-May-2011 15:25:52 GMT'))
->withDomain('.example.com')
->withSecure(true);

.. versionadded:: 5.1

The ``with*()`` methods were introduced in Symfony 5.1.

Managing the HTTP Cache
~~~~~~~~~~~~~~~~~~~~~~~
Expand Down