interface/modules/zend_modules/library/Zend/Http/Header/Cookie.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Http\Header;
  11
  12 use ArrayObject;
  13
  14 /**
  15  * @see http://www.ietf.org/rfc/rfc2109.txt
  16  * @see http://www.w3.org/Protocols/rfc2109/rfc2109
  17  */
  18 class Cookie extends ArrayObject implements HeaderInterface
  19 {
  20
  21     protected $encodeValue = true;
  22
  23     public static function fromSetCookieArray(array $setCookies)
  24     {
  25         $nvPairs = array();
  26         /* @var $setCookie SetCookie */
  27         foreach ($setCookies as $setCookie) {
  28             if (!$setCookie instanceof SetCookie) {
  29                 throw new Exception\InvalidArgumentException(__CLASS__ . '::' . __METHOD__ . ' requires an array of SetCookie objects');
  30             }
  31             if (array_key_exists($setCookie->getName(), $nvPairs)) {
  32                 throw new Exception\InvalidArgumentException('Two cookies with the same name were provided to ' . __CLASS__ . '::' . __METHOD__);
  33             }
  34
  35             $nvPairs[$setCookie->getName()] = $setCookie->getValue();
  36         }
  37         return new static($nvPairs);
  38     }
  39
  40     public static function fromString($headerLine)
  41     {
  42         $header = new static();
  43
  44         list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
  45
  46         // check to ensure proper header type for this factory
  47         if (strtolower($name) !== 'cookie') {
  48             throw new Exception\InvalidArgumentException('Invalid header line for Server string: "' . $name . '"');
  49         }
  50
  51         $nvPairs = preg_split('#;\s*#', $value);
  52
  53         $arrayInfo = array();
  54         foreach ($nvPairs as $nvPair) {
  55             $parts = explode('=', $nvPair, 2);
  56             if (count($parts) != 2) {
  57                 throw new Exception\RuntimeException('Malformed Cookie header found');
  58             }
  59             list($name, $value) = $parts;
  60             $arrayInfo[$name] = urldecode($value);
  61         }
  62
  63         $header->exchangeArray($arrayInfo);
  64
  65         return $header;
  66     }
  67
  68     public function __construct(array $array = array())
  69     {
  70         parent::__construct($array, ArrayObject::ARRAY_AS_PROPS);
  71     }
  72
  73     public function setEncodeValue($encodeValue)
  74     {
  75         $this->encodeValue = (bool) $encodeValue;
  76         return $this;
  77     }
  78
  79     public function getEncodeValue()
  80     {
  81         return $this->encodeValue;
  82     }
  83
  84     public function getFieldName()
  85     {
  86         return 'Cookie';
  87     }
  88
  89     public function getFieldValue()
  90     {
  91         $nvPairs = array();
  92
  93         foreach ($this as $name => $value) {
  94             $nvPairs[] = $name . '=' . (($this->encodeValue) ? urlencode($value) : $value);
  95         }
  96
  97         return implode('; ', $nvPairs);
  98     }
  99
 100     public function toString()
 101     {
 102         return 'Cookie: ' . $this->getFieldValue();
 103     }
 104
 105     /**
 106      * Get the cookie as a string, suitable for sending as a "Cookie" header in an
 107      * HTTP request
 108      *
 109      * @return string
 110      */
 111     public function __toString()
 112     {
 113         return $this->toString();
 114     }
 115
 116
 117 }