You are here

public function ServerRequest::withCookieParams in Zircon Profile 8

Same name in this branch
  1. 8 vendor/zendframework/zend-diactoros/src/ServerRequest.php \Zend\Diactoros\ServerRequest::withCookieParams()
  2. 8 vendor/symfony/psr-http-message-bridge/Tests/Fixtures/ServerRequest.php \Symfony\Bridge\PsrHttpMessage\Tests\Fixtures\ServerRequest::withCookieParams()
Same name and namespace in other branches
  1. 8.0 vendor/zendframework/zend-diactoros/src/ServerRequest.php \Zend\Diactoros\ServerRequest::withCookieParams()

Return an instance with the specified cookies.

The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST be compatible with the structure of $_COOKIE. Typically, this data will be injected at instantiation.

This method MUST NOT update the related Cookie header of the request instance, nor related values in the server params.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated cookie values.

Parameters

array $cookies Array of key/value pairs representing cookies.:

Return value

self

Overrides ServerRequestInterface::withCookieParams

File

vendor/zendframework/zend-diactoros/src/ServerRequest.php, line 128

Class

ServerRequest
Server-side HTTP request

Namespace

Zend\Diactoros

Code

public function withCookieParams(array $cookies) {
  $new = clone $this;
  $new->cookieParams = $cookies;
  return $new;
}