interface/modules/zend_modules/library/Zend/Http/Header/AbstractLocation.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 Zend\Uri\Exception as UriException;
  13 use Zend\Uri\Uri;
  14 use Zend\Uri\UriFactory;
  15 use Zend\Uri\UriInterface;
  16
  17
  18 /**
  19  * Abstract Location Header
  20  * Supports headers that have URI as value
  21  * @see Zend\Http\Header\Location
  22  * @see Zend\Http\Header\ContentLocation
  23  * @see Zend\Http\Header\Referer
  24  *
  25  * Note for 'Location' header:
  26  * While RFC 1945 requires an absolute URI, most of the browsers also support relative URI
  27  * This class allows relative URIs, and let user retrieve URI instance if strict validation needed
  28  */
  29 abstract class AbstractLocation implements HeaderInterface
  30 {
  31     /**
  32      * URI for this header
  33      *
  34      * @var UriInterface
  35      */
  36     protected $uri = null;
  37
  38     /**
  39      * Create location-based header from string
  40      *
  41      * @param string $headerLine
  42      * @return AbstractLocation
  43      * @throws Exception\InvalidArgumentException
  44      */
  45     public static function fromString($headerLine)
  46     {
  47         $locationHeader = new static();
  48
  49         // ZF-5520 - IIS bug, no space after colon
  50         list($name, $uri) = GenericHeader::splitHeaderLine($headerLine);
  51
  52         // check to ensure proper header type for this factory
  53         if (strtolower($name) !== strtolower($locationHeader->getFieldName())) {
  54             throw new Exception\InvalidArgumentException(
  55                 'Invalid header line for "' . $locationHeader->getFieldName() . '" header string'
  56             );
  57         }
  58
  59         $locationHeader->setUri(trim($uri));
  60
  61         return $locationHeader;
  62     }
  63
  64     /**
  65      * Set the URI/URL for this header, this can be a string or an instance of Zend\Uri\Http
  66      *
  67      * @param string|UriInterface $uri
  68      * @return AbstractLocation
  69      * @throws Exception\InvalidArgumentException
  70      */
  71     public function setUri($uri)
  72     {
  73         if (is_string($uri)) {
  74             try {
  75                 $uri = UriFactory::factory($uri);
  76             } catch (UriException\InvalidUriPartException $e) {
  77                 throw new Exception\InvalidArgumentException(
  78                         sprintf('Invalid URI passed as string (%s)', (string) $uri),
  79                         $e->getCode(),
  80                         $e
  81                 );
  82             }
  83         } elseif (!($uri instanceof UriInterface)) {
  84             throw new Exception\InvalidArgumentException('URI must be an instance of Zend\Uri\Http or a string');
  85         }
  86         $this->uri = $uri;
  87
  88         return $this;
  89     }
  90
  91     /**
  92      * Return the URI for this header
  93      *
  94      * @return string
  95      */
  96     public function getUri()
  97     {
  98         if ($this->uri instanceof UriInterface) {
  99             return $this->uri->toString();
 100         }
 101         return $this->uri;
 102     }
 103
 104     /**
 105      * Return the URI for this header as an instance of Zend\Uri\Http
 106      *
 107      * @return UriInterface
 108      */
 109     public function uri()
 110     {
 111         if ($this->uri === null || is_string($this->uri)) {
 112             $this->uri = UriFactory::factory($this->uri);
 113         }
 114         return $this->uri;
 115     }
 116
 117     /**
 118      * Get header value as URI string
 119      *
 120      * @return string
 121      */
 122     public function getFieldValue()
 123     {
 124         return $this->getUri();
 125     }
 126
 127     /**
 128      * Output header line
 129      *
 130      * @return string
 131      */
 132     public function toString()
 133     {
 134         return $this->getFieldName() . ': ' . $this->getUri();
 135     }
 136
 137     /**
 138      * Allow casting to string
 139      *
 140      * @return string
 141      */
 142     public function __toString()
 143     {
 144         return $this->toString();
 145     }
 146 }