yii\web\Response::getCookies PHP Method

getCookies() public method

Through the returned cookie collection, you add or remove cookies as follows, php add a cookie $response->cookies->add(new Cookie([ 'name' => $name, 'value' => $value, ]); remove a cookie $response->cookies->remove('name'); alternatively unset($response->cookies['name']);
public getCookies ( ) : CookieCollection
return CookieCollection the cookie collection.
    public function getCookies()
    {
        if ($this->_cookies === null) {
            $this->_cookies = new CookieCollection();
        }
        return $this->_cookies;
    }

Usage Example

Example #1
0
 /**
  * Restores response properties from the given data
  * @param Response $response the response to be restored
  * @param array $data the response property data
  * @since 2.0.3
  */
 protected function restoreResponse($response, $data)
 {
     if (isset($data['format'])) {
         $response->format = $data['format'];
     }
     if (isset($data['version'])) {
         $response->version = $data['version'];
     }
     if (isset($data['statusCode'])) {
         $response->statusCode = $data['statusCode'];
     }
     if (isset($data['statusText'])) {
         $response->statusText = $data['statusText'];
     }
     if (isset($data['headers']) && is_array($data['headers'])) {
         $headers = $response->getHeaders()->toArray();
         $response->getHeaders()->fromArray(array_merge($data['headers'], $headers));
     }
     if (isset($data['cookies']) && is_array($data['cookies'])) {
         $cookies = $response->getCookies()->toArray();
         $response->getCookies()->fromArray(array_merge($data['cookies'], $cookies));
     }
 }