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

OskarStark · OskarStark · commit c0b8a48e98d8 · 2020-02-24T07:57:05.000+01:00
This PR was merged into the master branch. Discussion ---------- [HttpFoundation] Document the Cookie::with*() methods Fixes #13016. Commits ------- d1dca39 [HttpFoundation] Document the Cookie::with*() methods
diff --git a/components/http_foundation.rst b/components/http_foundation.rst
@@ -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
 ~~~~~~~~~~~~~~~~~~~~~~~
