From 12ba37e8d2a3125ed316d35bc4ca5ca7f52d1bdf Mon Sep 17 00:00:00 2001
From: Philipp <admin@philipp.info>
Date: Thu, 23 Jun 2022 22:46:46 +0200
Subject: [PATCH] add more doc

---
 src/App/Request.php | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/src/App/Request.php b/src/App/Request.php
index c211dfe0e..43cabba85 100644
--- a/src/App/Request.php
+++ b/src/App/Request.php
@@ -40,6 +40,8 @@ class Request
 
 	/**
 	 * @return string The remote IP address of the current request
+	 *
+	 * Do always use this instead of $_SERVER['REMOTE_ADDR']
 	 */
 	public function getRemoteAddress(): string
 	{
@@ -58,6 +60,10 @@ class Request
 	 * Otherwise, $remoteAddress will be compared to $trustedProxy literally and the result
 	 * will be returned.
 	 *
+	 * @param string $trustedProxy  The current, trusted proxy to check
+	 * @param string $remoteAddress The current remote IP address
+	 *
+	 *
 	 * @return boolean true if $remoteAddress matches $trustedProxy, false otherwise
 	 */
 	protected function matchesTrustedProxy(string $trustedProxy, string $remoteAddress): bool
@@ -80,6 +86,9 @@ class Request
 	 * Checks if given $remoteAddress matches any entry in the given array $trustedProxies.
 	 * For details regarding what "match" means, refer to `matchesTrustedProxy`.
 	 *
+	 * @param string[] $trustedProxies A list of the trusted proxies
+	 * @param string   $remoteAddress  The current remote IP address
+	 *
 	 * @return boolean true if $remoteAddress matches any entry in $trustedProxies, false otherwise
 	 */
 	protected function isTrustedProxy(array $trustedProxies, string $remoteAddress): bool
@@ -94,6 +103,10 @@ class Request
 	}
 
 	/**
+	 * Determines the remote address, if the connection came from a trusted proxy
+	 * and `forwarded_for_headers` has been configured then the IP address
+	 * specified in this header will be returned instead.
+	 *
 	 * @param IManageConfigValues $config
 	 * @param array               $server
 	 *