vendor/zendframework/zend-uri/src/Http.php

   1 <?php
   2 /**
   3  * @see       https://github.com/zendframework/zend-uri for the canonical source repository
   4  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
   5  * @license   https://github.com/zendframework/zend-uri/blob/master/LICENSE.md New BSD License
   6  */
   7
   8 namespace Zend\Uri;
   9
  10 /**
  11  * HTTP URI handler
  12  */
  13 class Http extends Uri
  14 {
  15     /**
  16      * @see Uri::$validSchemes
  17      */
  18     protected static $validSchemes = [
  19         'http',
  20         'https'
  21     ];
  22
  23     /**
  24      * @see Uri::$defaultPorts
  25      */
  26     protected static $defaultPorts = [
  27         'http'  => 80,
  28         'https' => 443,
  29     ];
  30
  31     /**
  32      * @see Uri::$validHostTypes
  33      */
  34     protected $validHostTypes = self::HOST_DNS_OR_IPV4_OR_IPV6_OR_REGNAME;
  35
  36     /**
  37      * User name as provided in authority of URI
  38      * @var null|string
  39      */
  40     protected $user;
  41
  42     /**
  43      * Password as provided in authority of URI
  44      * @var null|string
  45      */
  46     protected $password;
  47
  48     /**
  49      * Get the username part (before the ':') of the userInfo URI part
  50      *
  51      * @return string|null
  52      */
  53     public function getUser()
  54     {
  55         return $this->user;
  56     }
  57
  58     /**
  59      * Get the password part (after the ':') of the userInfo URI part
  60      *
  61      * @return string|null
  62      */
  63     public function getPassword()
  64     {
  65         return $this->password;
  66     }
  67
  68     /**
  69      * Get the User-info (usually user:password) part
  70      *
  71      * @return string|null
  72      */
  73     public function getUserInfo()
  74     {
  75         return $this->userInfo;
  76     }
  77
  78     /**
  79      * Set the username part (before the ':') of the userInfo URI part
  80      *
  81      * @param string|null $user
  82      *
  83      * @return self
  84      */
  85     public function setUser($user)
  86     {
  87         $this->user = null === $user ? null : (string) $user;
  88
  89         $this->buildUserInfo();
  90
  91         return $this;
  92     }
  93
  94     /**
  95      * Set the password part (after the ':') of the userInfo URI part
  96      *
  97      * @param  string $password
  98      *
  99      * @return self
 100      */
 101     public function setPassword($password)
 102     {
 103         $this->password = null === $password ? null : (string) $password;
 104
 105         $this->buildUserInfo();
 106
 107         return $this;
 108     }
 109
 110     /**
 111      * Set the URI User-info part (usually user:password)
 112      *
 113      * @param  string|null $userInfo
 114      *
 115      * @return self
 116      *
 117      * @throws Exception\InvalidUriPartException If the schema definition does not have this part
 118      */
 119     public function setUserInfo($userInfo)
 120     {
 121         $this->userInfo = null === $userInfo ? null : (string) $userInfo;
 122
 123         $this->parseUserInfo();
 124
 125         return $this;
 126     }
 127
 128     /**
 129      * Validate the host part of an HTTP URI
 130      *
 131      * This overrides the common URI validation method with a DNS or IP only
 132      * default. Users may still enforce allowing other host types.
 133      *
 134      * @param  string  $host
 135      * @param  int $allowed
 136      * @return bool
 137      */
 138     public static function validateHost($host, $allowed = self::HOST_DNS_OR_IPV4_OR_IPV6)
 139     {
 140         return parent::validateHost($host, $allowed);
 141     }
 142
 143     /**
 144      * Parse the user info into username and password segments
 145      *
 146      * Parses the user information into username and password segments, and
 147      * then sets the appropriate values.
 148      *
 149      * @return void
 150      */
 151     protected function parseUserInfo()
 152     {
 153         // No user information? we're done
 154         if (null === $this->userInfo) {
 155             $this->setUser(null);
 156             $this->setPassword(null);
 157
 158             return;
 159         }
 160
 161         // If no ':' separator, we only have a username
 162         if (false === strpos($this->userInfo, ':')) {
 163             $this->setUser($this->userInfo);
 164             $this->setPassword(null);
 165             return;
 166         }
 167
 168         // Split on the ':', and set both user and password
 169         list($this->user, $this->password) = explode(':', $this->userInfo, 2);
 170     }
 171
 172     /**
 173      * Build the user info based on user and password
 174      *
 175      * Builds the user info based on the given user and password values
 176      *
 177      * @return void
 178      */
 179     protected function buildUserInfo()
 180     {
 181         if (null !== $this->password) {
 182             $this->userInfo = $this->user . ':' . $this->password;
 183         } else {
 184             $this->userInfo = $this->user;
 185         }
 186     }
 187
 188     /**
 189      * Return the URI port
 190      *
 191      * If no port is set, will return the default port according to the scheme
 192      *
 193      * @return int
 194      * @see    Zend\Uri\Uri::getPort()
 195      */
 196     public function getPort()
 197     {
 198         if (empty($this->port)) {
 199             if (array_key_exists($this->scheme, static::$defaultPorts)) {
 200                 return static::$defaultPorts[$this->scheme];
 201             }
 202         }
 203         return $this->port;
 204     }
 205
 206     /**
 207      * Parse a URI string
 208      *
 209      * @param  string $uri
 210      * @return Http
 211      */
 212     public function parse($uri)
 213     {
 214         parent::parse($uri);
 215
 216         if (empty($this->path)) {
 217             $this->path = '/';
 218         }
 219
 220         return $this;
 221     }
 222 }