Documented the arguments of the Cookie class

javiereguiluz · javiereguiluz · commit 27dff26c46e6 · 2016-04-05T17:00:29.000+02:00
diff --git a/components/http_foundation/introduction.rst b/components/http_foundation/introduction.rst
@@ -165,7 +165,7 @@ When PHP imports the request query, it handles request parameters like
     // returns array('bar' => 'bar')
 
     $request->query->get('foo[bar]');
-    // returns null   
+    // returns null
 
 .. _component-foundation-attributes:
 
@@ -374,7 +374,45 @@ attribute::
 The
 :method:`Symfony\\Component\\HttpFoundation\\ResponseHeaderBag::setCookie`
 method takes an instance of
-:class:`Symfony\\Component\\HttpFoundation\\Cookie` as an argument.
+:class:`Symfony\\Component\\HttpFoundation\\Cookie` as an argument. This class
+takes eight arguments in its constructor:
+
+``$name``
+    **type**: ``string`` **default**: none (this argument is mandatory)
+    The name of the cookie.
+``$value``
+    **type**: ``string`` **default**: ``null``
+    The value stored in the cookie.
+``$expire``
+    **type**: ``int``|``string``|``DateTime``|``DateTimeInterface`` **default**: 0
+    The time the cookie expires. This value can be set as a timestamp integer,
+    as a ``strtotime()`` valid date string (e.g. ``+1 week``), as a ``DateTime``
+    object or as an object which implements ``DateTimeInterface``.
+    The default value is ``0``, which deletes the cookie as soon as the browser
+    is closed.
+``$path``
+    **type**: ``string`` **default**: ``/``
+    The path on the server in which the cookie will be available on. The default
+    values makes the cookie available on any URL of the server.
+``$domain``
+    **type**: ``string`` **default**: ``null``
+    The domain that the cookie is available to. The default value makes the cookie
+    available just for the current domain (and any of its subdomains).
+``$secure``
+    **type**: ``bool`` **default**: ``false``
+    Whether the cookie should only be transmitted over a secure HTTPS connection
+    from the client.
+``$httpOnly``
+    **type**: ``bool`` **default**: ``true``
+    Whether the cookie will be made accessible only through the HTTP protocol.
+``$raw``
+    .. versionadded:: 3.1
+         The ``$raw`` argument was introduced in Symfony 3.1.
+
+    **type**: ``bool`` **default**: ``false``
+    Whether the cookie value should be sent with no URL encoding. If set to
+    ``true`` the cookie is created with the ``setrawcookie()`` PHP function
+    instead of ``setcookie()``.
 
 You can clear a cookie via the
 :method:`Symfony\\Component\\HttpFoundation\\ResponseHeaderBag::clearCookie` method.
