RequestContext.php 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Routing;
  11. use Symfony\Component\HttpFoundation\Request;
  12. /**
  13. * Holds information about the current request.
  14. *
  15. * This class implements a fluent interface.
  16. *
  17. * @author Fabien Potencier <fabien@symfony.com>
  18. * @author Tobias Schultze <http://tobion.de>
  19. */
  20. class RequestContext
  21. {
  22. private string $baseUrl;
  23. private string $pathInfo;
  24. private string $method;
  25. private string $host;
  26. private string $scheme;
  27. private int $httpPort;
  28. private int $httpsPort;
  29. private string $queryString;
  30. private array $parameters = [];
  31. public function __construct(string $baseUrl = '', string $method = 'GET', string $host = 'localhost', string $scheme = 'http', int $httpPort = 80, int $httpsPort = 443, string $path = '/', string $queryString = '')
  32. {
  33. $this->setBaseUrl($baseUrl);
  34. $this->setMethod($method);
  35. $this->setHost($host);
  36. $this->setScheme($scheme);
  37. $this->setHttpPort($httpPort);
  38. $this->setHttpsPort($httpsPort);
  39. $this->setPathInfo($path);
  40. $this->setQueryString($queryString);
  41. }
  42. public static function fromUri(string $uri, string $host = 'localhost', string $scheme = 'http', int $httpPort = 80, int $httpsPort = 443): self
  43. {
  44. $uri = parse_url($uri);
  45. $scheme = $uri['scheme'] ?? $scheme;
  46. $host = $uri['host'] ?? $host;
  47. if (isset($uri['port'])) {
  48. if ('http' === $scheme) {
  49. $httpPort = $uri['port'];
  50. } elseif ('https' === $scheme) {
  51. $httpsPort = $uri['port'];
  52. }
  53. }
  54. return new self($uri['path'] ?? '', 'GET', $host, $scheme, $httpPort, $httpsPort);
  55. }
  56. /**
  57. * Updates the RequestContext information based on a HttpFoundation Request.
  58. *
  59. * @return $this
  60. */
  61. public function fromRequest(Request $request): static
  62. {
  63. $this->setBaseUrl($request->getBaseUrl());
  64. $this->setPathInfo($request->getPathInfo());
  65. $this->setMethod($request->getMethod());
  66. $this->setHost($request->getHost());
  67. $this->setScheme($request->getScheme());
  68. $this->setHttpPort($request->isSecure() || null === $request->getPort() ? $this->httpPort : $request->getPort());
  69. $this->setHttpsPort($request->isSecure() && null !== $request->getPort() ? $request->getPort() : $this->httpsPort);
  70. $this->setQueryString($request->server->get('QUERY_STRING', ''));
  71. return $this;
  72. }
  73. /**
  74. * Gets the base URL.
  75. */
  76. public function getBaseUrl(): string
  77. {
  78. return $this->baseUrl;
  79. }
  80. /**
  81. * Sets the base URL.
  82. *
  83. * @return $this
  84. */
  85. public function setBaseUrl(string $baseUrl): static
  86. {
  87. $this->baseUrl = rtrim($baseUrl, '/');
  88. return $this;
  89. }
  90. /**
  91. * Gets the path info.
  92. */
  93. public function getPathInfo(): string
  94. {
  95. return $this->pathInfo;
  96. }
  97. /**
  98. * Sets the path info.
  99. *
  100. * @return $this
  101. */
  102. public function setPathInfo(string $pathInfo): static
  103. {
  104. $this->pathInfo = $pathInfo;
  105. return $this;
  106. }
  107. /**
  108. * Gets the HTTP method.
  109. *
  110. * The method is always an uppercased string.
  111. */
  112. public function getMethod(): string
  113. {
  114. return $this->method;
  115. }
  116. /**
  117. * Sets the HTTP method.
  118. *
  119. * @return $this
  120. */
  121. public function setMethod(string $method): static
  122. {
  123. $this->method = strtoupper($method);
  124. return $this;
  125. }
  126. /**
  127. * Gets the HTTP host.
  128. *
  129. * The host is always lowercased because it must be treated case-insensitive.
  130. */
  131. public function getHost(): string
  132. {
  133. return $this->host;
  134. }
  135. /**
  136. * Sets the HTTP host.
  137. *
  138. * @return $this
  139. */
  140. public function setHost(string $host): static
  141. {
  142. $this->host = strtolower($host);
  143. return $this;
  144. }
  145. /**
  146. * Gets the HTTP scheme.
  147. */
  148. public function getScheme(): string
  149. {
  150. return $this->scheme;
  151. }
  152. /**
  153. * Sets the HTTP scheme.
  154. *
  155. * @return $this
  156. */
  157. public function setScheme(string $scheme): static
  158. {
  159. $this->scheme = strtolower($scheme);
  160. return $this;
  161. }
  162. /**
  163. * Gets the HTTP port.
  164. */
  165. public function getHttpPort(): int
  166. {
  167. return $this->httpPort;
  168. }
  169. /**
  170. * Sets the HTTP port.
  171. *
  172. * @return $this
  173. */
  174. public function setHttpPort(int $httpPort): static
  175. {
  176. $this->httpPort = $httpPort;
  177. return $this;
  178. }
  179. /**
  180. * Gets the HTTPS port.
  181. */
  182. public function getHttpsPort(): int
  183. {
  184. return $this->httpsPort;
  185. }
  186. /**
  187. * Sets the HTTPS port.
  188. *
  189. * @return $this
  190. */
  191. public function setHttpsPort(int $httpsPort): static
  192. {
  193. $this->httpsPort = $httpsPort;
  194. return $this;
  195. }
  196. /**
  197. * Gets the query string without the "?".
  198. */
  199. public function getQueryString(): string
  200. {
  201. return $this->queryString;
  202. }
  203. /**
  204. * Sets the query string.
  205. *
  206. * @return $this
  207. */
  208. public function setQueryString(?string $queryString): static
  209. {
  210. // string cast to be fault-tolerant, accepting null
  211. $this->queryString = (string) $queryString;
  212. return $this;
  213. }
  214. /**
  215. * Returns the parameters.
  216. */
  217. public function getParameters(): array
  218. {
  219. return $this->parameters;
  220. }
  221. /**
  222. * Sets the parameters.
  223. *
  224. * @param array $parameters The parameters
  225. *
  226. * @return $this
  227. */
  228. public function setParameters(array $parameters): static
  229. {
  230. $this->parameters = $parameters;
  231. return $this;
  232. }
  233. /**
  234. * Gets a parameter value.
  235. */
  236. public function getParameter(string $name): mixed
  237. {
  238. return $this->parameters[$name] ?? null;
  239. }
  240. /**
  241. * Checks if a parameter value is set for the given parameter.
  242. */
  243. public function hasParameter(string $name): bool
  244. {
  245. return \array_key_exists($name, $this->parameters);
  246. }
  247. /**
  248. * Sets a parameter value.
  249. *
  250. * @return $this
  251. */
  252. public function setParameter(string $name, mixed $parameter): static
  253. {
  254. $this->parameters[$name] = $parameter;
  255. return $this;
  256. }
  257. public function isSecure(): bool
  258. {
  259. return 'https' === $this->scheme;
  260. }
  261. }