interface/modules/zend_modules/library/Zend/Http/Header/GenericHeader.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  * Content-Location Header
  14  *
  15   */
  16 class GenericHeader implements HeaderInterface
  17 {
  18     /**
  19      * @var string
  20      */
  21     protected $fieldName = null;
  22
  23     /**
  24      * @var string
  25      */
  26     protected $fieldValue = null;
  27
  28     /**
  29      * Factory to generate a header object from a string
  30      *
  31      * @static
  32      * @param string $headerLine
  33      * @return GenericHeader
  34      */
  35     public static function fromString($headerLine)
  36     {
  37         list($fieldName, $fieldValue) = GenericHeader::splitHeaderLine($headerLine);
  38         $header = new static($fieldName, $fieldValue);
  39         return $header;
  40     }
  41
  42     /**
  43      * Splits the header line in `name` and `value` parts.
  44      *
  45      * @param string $headerLine
  46      * @return string[] `name` in the first index and `value` in the second.
  47      * @throws Exception\InvalidArgumentException If header does not match with the format ``name:value``
  48      */
  49     public static function splitHeaderLine($headerLine)
  50     {
  51         $parts = explode(':', $headerLine, 2);
  52         if (count($parts) !== 2) {
  53             throw new Exception\InvalidArgumentException('Header must match with the format "name:value"');
  54         }
  55
  56         $parts[1] = ltrim($parts[1]);
  57
  58         return $parts;
  59     }
  60
  61     /**
  62      * Constructor
  63      *
  64      * @param null|string $fieldName
  65      * @param null|string $fieldValue
  66      */
  67     public function __construct($fieldName = null, $fieldValue = null)
  68     {
  69         if ($fieldName) {
  70             $this->setFieldName($fieldName);
  71         }
  72
  73         if ($fieldValue !== null) {
  74             $this->setFieldValue($fieldValue);
  75         }
  76     }
  77
  78     /**
  79      * Set header field name
  80      *
  81      * @param  string $fieldName
  82      * @return GenericHeader
  83      * @throws Exception\InvalidArgumentException If the name does not match with RFC 2616 format.
  84      */
  85     public function setFieldName($fieldName)
  86     {
  87         if (!is_string($fieldName) || empty($fieldName)) {
  88             throw new Exception\InvalidArgumentException('Header name must be a string');
  89         }
  90
  91         // Pre-filter to normalize valid characters, change underscore to dash
  92         $fieldName = str_replace('_', '-', $fieldName);
  93
  94         /*
  95          * Following RFC 2616 section 4.2
  96          *
  97          * message-header = field-name ":" [ field-value ]
  98          * field-name     = token
  99          *
 100          * @see http://tools.ietf.org/html/rfc2616#section-2.2 for token definition.
 101          */
 102         if (!preg_match('/^[!#-\'*+\-\.0-9A-Z\^-z|~]+$/', $fieldName)) {
 103             throw new Exception\InvalidArgumentException(
 104                 'Header name must be a valid RFC 2616 (section 4.2) field-name.'
 105             );
 106         }
 107
 108         $this->fieldName = $fieldName;
 109         return $this;
 110     }
 111
 112     /**
 113      * Retrieve header field name
 114      *
 115      * @return string
 116      */
 117     public function getFieldName()
 118     {
 119         return $this->fieldName;
 120     }
 121
 122     /**
 123      * Set header field value
 124      *
 125      * @param  string $fieldValue
 126      * @return GenericHeader
 127      */
 128     public function setFieldValue($fieldValue)
 129     {
 130         $fieldValue = (string) $fieldValue;
 131
 132         if (preg_match('/^\s+$/', $fieldValue)) {
 133             $fieldValue = '';
 134         }
 135
 136         $this->fieldValue = $fieldValue;
 137         return $this;
 138     }
 139
 140     /**
 141      * Retrieve header field value
 142      *
 143      * @return string
 144      */
 145     public function getFieldValue()
 146     {
 147         return $this->fieldValue;
 148     }
 149
 150     /**
 151      * Cast to string as a well formed HTTP header line
 152      *
 153      * Returns in form of "NAME: VALUE\r\n"
 154      *
 155      * @return string
 156      */
 157     public function toString()
 158     {
 159         return $this->getFieldName() . ': ' . $this->getFieldValue();
 160     }
 161 }