interface/modules/zend_modules/library/Zend/Http/Header/Connection.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 /**
  13  * Connection Header
  14  *
  15  * @link       http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.10
  16  */
  17 class Connection implements HeaderInterface
  18 {
  19     const CONNECTION_CLOSE      = 'close';
  20     const CONNECTION_KEEP_ALIVE = 'keep-alive';
  21
  22     /**
  23      * Value of this header
  24      *
  25      * @var string
  26      */
  27     protected $value = self::CONNECTION_KEEP_ALIVE;
  28
  29     /**
  30      * @param $headerLine
  31      * @return Connection
  32      * @throws Exception\InvalidArgumentException
  33      */
  34     public static function fromString($headerLine)
  35     {
  36         $header = new static();
  37
  38         list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
  39
  40         // check to ensure proper header type for this factory
  41         if (strtolower($name) !== 'connection') {
  42             throw new Exception\InvalidArgumentException('Invalid header line for Connection string: "' . $name . '"');
  43         }
  44
  45         $header->setValue(trim($value));
  46
  47         return $header;
  48     }
  49
  50
  51     /**
  52      * Set Connection header to define persistent connection
  53      *
  54      * @param  bool $flag
  55      * @return Connection
  56      */
  57     public function setPersistent($flag)
  58     {
  59         if ((bool) $flag === true) {
  60             $this->value = self::CONNECTION_KEEP_ALIVE;
  61         } else {
  62             $this->value = self::CONNECTION_CLOSE;
  63         }
  64         return $this;
  65     }
  66
  67     /**
  68      * Get whether this connection is persistent
  69      *
  70      * @return bool
  71      */
  72     public function isPersistent()
  73     {
  74         return ($this->value === self::CONNECTION_KEEP_ALIVE);
  75     }
  76
  77     /**
  78      * Set arbitrary header value
  79      * RFC allows any token as value, 'close' and 'keep-alive' are commonly used
  80      *
  81      * @param string $value
  82      * @return Connection
  83      */
  84     public function setValue($value)
  85     {
  86         $this->value = strtolower($value);
  87         return $this;
  88     }
  89
  90
  91     /**
  92      * Connection header name
  93      *
  94      * @return string
  95      */
  96     public function getFieldName()
  97     {
  98         return 'Connection';
  99     }
 100
 101     /**
 102      * Connection header value
 103      *
 104      * @return string
 105      */
 106     public function getFieldValue()
 107     {
 108         return $this->value;
 109     }
 110
 111     /**
 112      * Return header line
 113      *
 114      * @return string
 115      */
 116     public function toString()
 117     {
 118         return 'Connection: ' . $this->getFieldValue();
 119     }
 120 }