add more doc

diff --git a/src/App/Request.php b/src/App/Request.php
index c211dfe0e100cbf75d8c1c8f332cff7c29b98ab2..43cabba856e513e76b39c0c4f7df14e491251e7a 100644 (file)
--- 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
         *